NEnetxms
Objects

Create a new object

Changed on

Create a new object. The caller must have CREATE access on the parent object (or on the entire network when creating a top-level node). The class field selects the object type and determines which additional fields are meaningful; fields not relevant to the selected class are ignored. After construction the same document is applied to the new object using merge-patch semantics (see PATCH /v1/objects/{object-id}), so common scalar properties such as comments and alias can be set in the same call. On success the full created object is returned and the Location header points to it.

post/v1/objects

Request

  • Base URL
    http://127.0.0.1:8000
  • URL
    http://127.0.0.1:8000/v1/objects
  • Auth
    HTTP bearer

Request body

class'Subnet' | 'Node' | 'Interface' | 'Container' | 'Zone' | 'Template' | 'TemplateGroup' | 'NetworkService' | 'VPNConnector' | 'Condition' | 'Cluster' | 'BusinessServiceProto' | 'Asset' | 'AssetGroup' | 'NetworkMapGroup' | 'NetworkMap' | 'Dashboard' | 'DashboardTemplate' | 'DashboardGroup' | 'BusinessService' | 'Collector' | 'Circuit' | 'MobileDevice' | 'Rack' | 'WirelessDomain' | 'Chassis' | 'Sensor' | 'CloudDomain' | 'Facility' | 'PowerDomain' | 'CoolingZone' | 'Room' required

Symbolic object class name.

namestring required

Object name.

parentIdinteger

Parent object ID. Required for all classes except Node (where a parent subnet is resolved automatically from the IP address when omitted).

zoneUINinteger

Zone UIN (when zoning is enabled).

commentsstring

Free-form object comments.

aliasstring

Object alias.

timeZonestring

IANA time zone name (see PATCH /v1/objects/{object-id} for semantics).

timeZoneRulestring

Optional POSIX TZ rule for timeZone.

assetIdinteger

Optional ID of an existing asset object to link to the new object.

primaryNamestring

(Node) Primary host name. If present it is resolved to the primary IP address.

ipAddressstring

(Node/Interface/Subnet) IP address. For a node it is the primary IP address used when no primary name is given.

creationFlagsinteger

(Node) Bit mask controlling node creation (disable polling protocols, create unmanaged, etc.).

agentPortinteger
snmpPortinteger
etherNetIpPortinteger
etherNetIpAddressstring
modbusTcpPortinteger
modbusUnitIdinteger

(Node/Sensor) Modbus unit ID.

sshLoginstring
sshPasswordstring
sshPortinteger
vncPasswordstring
vncPortinteger
agentProxyinteger
snmpProxyinteger
mqttProxyinteger
modbusProxyinteger
etherNetIpProxyinteger
icmpProxyinteger
sshProxyinteger
vncProxyinteger
webServiceProxyinteger
ifIndexinteger

(Interface) Interface index.

ifTypeinteger

(Interface) Interface type (IANA ifType).

macAddressstring

(Interface/Sensor) MAC address.

chassisinteger

(Interface) Physical chassis number.

moduleinteger

(Interface) Physical module number.

picinteger

(Interface) Physical PIC number.

portinteger

(Interface) Physical port number.

physicalPortboolean

(Interface) Whether the interface is a physical port.

serviceTypeinteger

(NetworkService) Service type.

ipProtocolinteger

(NetworkService) IP protocol number (default 6/TCP).

ipPortinteger

(NetworkService) Port number.

requeststring

(NetworkService) Request string sent to the service.

responsestring

(NetworkService) Expected response string.

createStatusDciboolean

(NetworkService) Create a status DCI on the parent node.

mapTypeinteger

(NetworkMap) Map type.

mapCanvasTypeinteger

(NetworkMap) Canvas rendering type.

seedObjectsinteger[]

(NetworkMap) Seed object IDs.

controllerIdinteger

(Chassis) Controller node ID.

heightinteger

(Rack) Rack height in units (default 42). (Room) Room height in millimetres; 0 means undeclared.

widthinteger

(Rack) External cabinet width in millimetres (default 600). (Room) Width of generated rectangular outline in millimetres (default 6000); ignored if outline is provided.

depthinteger

(Rack) External cabinet depth in millimetres (default 1000). (Room) Depth of generated rectangular outline in millimetres (default 6000); ignored if outline is provided.

roomType'COMPUTER_ROOM' | 'ELECTRICAL' | 'MECHANICAL' | 'TELECOM' | 'OTHER'

Kind of room.

deviceIdstring

(MobileDevice) Device identifier.

instanceDiscoveryMethodinteger

(BusinessServiceProto) Instance discovery method.

flagsinteger

(Sensor) Sensor flags.

deviceClassinteger

(Sensor) Sensor device class.

vendorstring

(Sensor) Vendor name.

modelstring

(Sensor) Model.

serialNumberstring

(Sensor) Serial number.

deviceAddressstring

(Sensor) Device address.

gatewayNodeinteger

(Sensor) Gateway node ID.

connectorNamestring

(CloudDomain) Cloud connector name.

discoveryFilterstring

(CloudDomain) Resource discovery filter.

removalPolicyinteger

(CloudDomain) Resource removal policy.

gracePeriodinteger

(CloudDomain) Grace period in seconds before removing vanished resources.

settlementLaginteger

(Facility) Number of days a provisional day waits before settlement (default 5).

providerIdstring

(Facility) Selected KPI computation provider; empty disables the engine.

domainType'GRID_ENTRY' | 'GENERATOR' | 'UPS' | 'PDU' | 'BUSWAY' | 'OTHER'

Role of the power domain in the electrical distribution tree.

feedTagstring

(PowerDomain) Feed label, conventionally A or B.

ratedPowerinteger

(PowerDomain) Nameplate power in watts; 0 means undeclared.

zoneType'PLANT' | 'ZONE' | 'OTHER'

Kind of cooling zone.

ratedCapacityinteger

(CoolingZone) Rated thermal capacity in watts; 0 means undeclared.

assetPropertiesobject

(Asset) Asset attribute values keyed by attribute name. All mandatory attributes must be present.

linkedObjectIdinteger

(Asset) Optional ID of an existing object to link the new asset to. Server will update asset identification (serial number or MAC address) from that object and run auto fill scripts after linking. Requires modify access to that object.

componentSerialstring

(Asset) Optional serial number of a component of the linked object (stack member, transceiver, disk, etc.). When set, the new asset is linked to that component instead of the object itself, linked object must be a node, and the serial number must be present in node's ENTITY-MIB component tree or agent hardware inventory. Node's own asset link is not affected. Serial number is written into asset's serial number attribute.

Response

Object created. Response body is the full object representation.

aliasstring

Object alias

categoryinteger

Object category ID

class'AccessPoint' | 'AgentPolicyLogParser' | 'Asset' | 'AssetGroup' | 'AssetRoot' | 'BusinessService' | 'BusinessServiceProto' | 'BusinessServiceRoot' | 'Chassis' | 'Cluster' | 'Condition' | 'Container' | 'CoolingZone' | 'Dashboard' | 'DashboardGroup' | 'DashboardRoot' | 'Facility' | 'Generic' | 'Interface' | 'MobileDevice' | 'Network' | 'NetworkMap' | 'NetworkMapGroup' | 'NetworkMapRoot' | 'NetworkService' | 'Node' | 'NodeLink' | 'PowerDomain' | 'Rack' | 'Report' | 'ReportGroup' | 'ReportRoot' | 'Room' | 'Sensor' | 'ServiceCheck' | 'ServiceRoot' | 'Subnet' | 'Template' | 'TemplateGroup' | 'TemplateRoot' | 'VPNConnector' | 'Zone'
guidstring uuid

Object GUID

idinteger

Object ID

namestring

Object name

timestampstring date-time

Object last change timestamp

timeZonestring nullable

Effective IANA time zone name (own or inherited from a parent object), null if not set.

timeZoneRulestring nullable

POSIX TZ rule of the effective time zone, null if not set.

timeZoneSourceinteger

ID of the parent object the time zone is inherited from, or 0 when the time zone is defined on this object or not set.

status0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8

Changes

  • 049a309c1a16Revision changes
    • info

      added the new optional request property

  • 53fbfac7f424Revision changes
    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status