Update Start Network Node Config (v2.0)

PUT 
/v2.0/api/tenants/:tenant_id/sites/:site_id/deviceidconfigs/:deviceid_config_id/snmpdiscoverystartnodes/:deviceid_start_node_id

Update Start Network Node config.

Request

Path Parameters

tenant_id stringrequired

The tenant ID

site_id stringrequired

The site ID.

deviceid_config_id stringrequired

The deviceid config ID.

deviceid_start_node_id stringrequired

The deviceid start node ID.

application/json

Body

Details of the Device ID start network node config to be updated

description

The device id start node description.

id string

The device ID.

ipv4_address stringrequired

The IPv4 address used as the starting point for network and device discovery.

name stringrequired

Device ID start node name.

scope StartNodeScopeConfig[]
Subnet scopes. A maximum of eight subnets can be entered per start node. This limits the discovery to a set of devices within the specified scope.
Array [
ipv4_prefix string
The prefix of the IPv4 address.
]
tags string[]

A information field that can be added to start nodes. Maximum 10 unique tags of length 1024 each are allowed.

Responses

200

Successful Operation

application/json

Schema

Schema

description

The device id start node description.

id string

The device ID.

ipv4_address stringrequired

The IPv4 address used as the starting point for network and device discovery.

name stringrequired

Device ID start node name.

scope StartNodeScopeConfig[]
Subnet scopes. A maximum of eight subnets can be entered per start node. This limits the discovery to a set of devices within the specified scope.
Array [
ipv4_prefix string
The prefix of the IPv4 address.
]
tags string[]

A information field that can be added to start nodes. Maximum 10 unique tags of length 1024 each are allowed.

Example (from schema)

{
  "id": "string",
  "ipv4_address": "string",
  "name": "string",
  "scope": [
    {
      "ipv4_prefix": "string"
    }
  ],
  "tags": [
    "string"
  ]
}

400

Bad Request

application/json

Schema

Schema

_error ErrorResponse[]
Array [
code string
The error code.
message string
The error message.
]

Example (from schema)

{
  "_error": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

Example

{
  "value": {
    "_error": [
      {
        "code": "DEVICEID_START_NODE_MAX_LIMIT"
      }
    ]
  }
}

Loading...