Sign in

v2

latestOpenAPI 3.0.12026-07-263104131.9 MB
Node Roles

Create node roles

Create multiple node roles

post/v2/noderole

Request body

nodeClass'WINDOWS_SERVER' | 'WINDOWS_WORKSTATION' | 'LINUX_WORKSTATION' | 'MAC' | 'ANDROID' | 'APPLE_IOS' | 'APPLE_IPADOS' | 'AOSP' | 'VMWARE_VM_HOST' | 'VMWARE_VM_GUEST' | 'HYPERV_VMM_HOST' | 'HYPERV_VMM_GUEST' | 'LINUX_SERVER' | 'MAC_SERVER' | 'CLOUD_MONITOR_TARGET' | 'NMS_SWITCH' | 'NMS_ROUTER' | 'NMS_FIREWALL' | 'NMS_PRIVATE_NETWORK_GATEWAY' | 'NMS_PRINTER' | 'NMS_SCANNER' | 'NMS_DIAL_MANAGER' | 'NMS_WAP' | 'NMS_IPSLA' | 'NMS_COMPUTER' | 'NMS_VM_HOST' | 'NMS_APPLIANCE' | 'NMS_OTHER' | 'NMS_SERVER' | 'NMS_PHONE' | 'NMS_VIRTUAL_MACHINE' | 'NMS_NETWORK_MANAGEMENT_AGENT' | 'UNMANAGED_DEVICE' | 'MANAGED_DEVICE'

Node Class of the Device Role. Should match Parent Device Role's Node Class.

nodeRoleParentNamestring

Name of a Device Parent that will be created in this request that will act as the Parent Device Role for this Device Role. Should be null if nodeRoleParentId is assigned.

nodeRoleParentIdinteger

Id of an already existing Device Role to create this Node Role Under. Should be null if nodeRoleParentName is assigned.

namestring

Device Role Name. Must be unique.

descriptionstring

Device Role Description.

chassisType'UNKNOWN' | 'DESKTOP' | 'LAPTOP' | 'MOBILE'

Chassis Type for the Managed Device Roles that utilize it such as Workstations. Should be null if unused.

iconstring

Icon Name of white-listed icon to be used for Unmanaged Device Roles. Should be null for all Managed Device Roles.

Response

Returns list of created node role

nodeClass'WINDOWS_SERVER' | 'WINDOWS_WORKSTATION' | 'LINUX_WORKSTATION' | 'MAC' | 'ANDROID' | 'APPLE_IOS' | 'APPLE_IPADOS' | 'AOSP' | 'VMWARE_VM_HOST' | 'VMWARE_VM_GUEST' | 'HYPERV_VMM_HOST' | 'HYPERV_VMM_GUEST' | 'LINUX_SERVER' | 'MAC_SERVER' | 'CLOUD_MONITOR_TARGET' | 'NMS_SWITCH' | 'NMS_ROUTER' | 'NMS_FIREWALL' | 'NMS_PRIVATE_NETWORK_GATEWAY' | 'NMS_PRINTER' | 'NMS_SCANNER' | 'NMS_DIAL_MANAGER' | 'NMS_WAP' | 'NMS_IPSLA' | 'NMS_COMPUTER' | 'NMS_VM_HOST' | 'NMS_APPLIANCE' | 'NMS_OTHER' | 'NMS_SERVER' | 'NMS_PHONE' | 'NMS_VIRTUAL_MACHINE' | 'NMS_NETWORK_MANAGEMENT_AGENT' | 'UNMANAGED_DEVICE' | 'MANAGED_DEVICE'

Node Class of the Device Role. Should match Parent Device Role's Node Class.

nodeRoleParentNamestring

Name of a Device Parent that will be created in this request that will act as the Parent Device Role for this Device Role. Should be null if nodeRoleParentId is assigned.

nodeRoleParentIdinteger

Id of an already existing Device Role to create this Node Role Under. Should be null if nodeRoleParentName is assigned.

namestring

Device Role Name. Must be unique.

descriptionstring

Device Role Description.

chassisType'UNKNOWN' | 'DESKTOP' | 'LAPTOP' | 'MOBILE'

Chassis Type for the Managed Device Roles that utilize it such as Workstations. Should be null if unused.

iconstring

Icon Name of white-listed icon to be used for Unmanaged Device Roles. Should be null for all Managed Device Roles.