Deprecated media types appear as crossed out in the index.
Field Name | Name of each xml or json element or attribute in the resource model. Attribute names are preceded by @ (for example, @total). Key fields are preceded by * (for example, *id). |
Type | Data Type for each field. Valid field types are: Integer, Float, Double, String, String(URI), Boolean, Date, enum, <custom>, and <custom>[]. |
Read Only | Whether this field is Read Only (State Data) and can never be directly updated or modified by the user. Note that "Read Only" is a property of a given element in the current media type and the same element in a related media type may not have the same value for it's "Read Only" property. |
GET | Whether this field is included in the HTTP Response of a GET Request. All resource model fields are always included in a GET Response. (Y means the field is included.) |
PUT/POST | Whether this field can be specified in the HTTP Request Body of a PUT or a POST method. (Y means the field can be specified. Y* means the field is required.) |
PATCH | Whether this field can be patched in the HTTP Request Body of a PATCH Request. (Y means the field can be patched.) |
Sort | Whether the GET response can be sorted on this field. Sort is only applicable to collection fields. See Sorting. |
Filter | Whether the GET response can be filtered on this field. Filter is only applicable to collection fields. See Filtering. |
Description | Field description. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this acknowledge-device-fingerprint-request node in the current node context. |
acknowledge-devices | acknowledge-device-fingerprint-request. | N | Y | Y | List of acknowledge-devices. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this acknowledgeDeviceLists node in the current node context. |
acknowledge-device | acknowledge-device-fingerprint-request. | N | Y | Y * | "acknowledge-device" node provides details of devices and their corresponding fingerprints. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | N | Link to this acknowledgeDevice node in the current node context. |
device | acknowledge-device-fingerprint-request. | N | Y | Y * | N | N | "device" node is used to specify the device which is used in the acknowledgement operation. |
fingerprint | String | N | Y | Y | N | N | SSH Public key Fingerprint. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@href | String(URI) | N | Y | Y * | Link to an external device. Hyperlink Template: /api/space/device-management/devices/{*ID}. |
id | Integer | Y | Y | N | Device ID. |
name | String | Y | Y | N | Device Name. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this acknowledge-fingerprint-job-results node in the current node context. |
@total | Integer | Y | Y | N | Total number of acknowledge-fingerprint-job-results in the API result set. |
acknowledge-device-fingerprint-job-result | acknowledge-fingerprint-job-results. | N | Y | Y * |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | N | Link to this acknowledgeDeviceFingerprintJobResult node in the current node context. |
id | Integer | Y | Y | N | N | N | Job result table row ID. |
device-name | String | N | Y | Y * | Y | N | Device Name. |
status | String | N | Y | Y * | Y | N | Status. |
description | String | N | Y | Y * | Y | N | Description. |
device-address | String | N | Y | Y * | Y | N | Device Address. |
job-instance-id | Integer | N | Y | Y * | N | N | Job Instance ID. |
Field Name | Type | Read Only | GET | PUT / POST | Description | ||||||
---|---|---|---|---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this activate-modeled-device-device-init-request node in the current node context. |
||||||
connection-profile | activate-modeled-device-device-init-request. | N | Y | Y * | |||||||
static-ip | String | N | Y | Y | Static IP address to be set to the device (Static Connection Profile). |
||||||
subnet-id | String | N | Y | Y | Subnet Prefix to be set to the device (Static Connection Profile). |
||||||
gateway | String | N | Y | Y | Gateway to be set to the device (Static Connection Profile). |
||||||
serial-number-validation | Boolean | N | Y | Y | Should serial number validation be performed. Default: false. |
||||||
user-name | String | N | Y | Y * | Username to authenticate with the device. |
||||||
password | String | N | Y | Y | Password to authenticate with the device. |
||||||
key-based | Boolean | N | Y | Y | Should key based authentication be performed. Default: false. |
||||||
serial-number | String | N | Y | Y | Serial number of the device, in case serial number validation is enabled. |
||||||
Configuration-update-type | enum(Configuration-update-type) | N | Y | Y | Should the configuration be updated manually or automatically. Possible Values:
Default: AUTOMATIC. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this connectionProfileMOREST node in the current node context. |
@href | String(URI) | N | Y | Y * | Link to an external connectionProfileMOREST. Hyperlink Template: /api/space/device-management/modeled-device-management/connection-profiles/{*ID}. |
id | Integer | Y | Y | N | ID of the conneciton profile. |
name | String | N | Y | Y | Name of the connection profile. |
Field Name | Type | Read Only | GET | PUT / POST | Description | ||||||
---|---|---|---|---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this activate-modeled-device-space-init-request node in the current node context. |
||||||
host | String | N | Y | Y * | Hostname/IP address of the device. |
||||||
user-name | String | N | Y | Y * | Username to authenticate with the device. |
||||||
password | String | N | Y | Y | Password to authenticate with the device. |
||||||
key-based | Boolean | N | Y | Y | Should key based authentication be performed. Default: false. |
||||||
use-nat | Boolean | N | Y | Y | Is JNAP server behind NAT [NAT enabled]. Default: false. |
||||||
create-new-user | Boolean | N | Y | Y | Should a new user be created on the device. Default: false. |
||||||
new-user-name | String | N | Y | Y | User name for the new user. |
||||||
new-user-password | String | N | Y | Y | Password for the new user. |
||||||
new-user-key-based | Boolean | N | Y | Y | Perform key based authentication for the new user. Default: false. |
||||||
serial-number-validation | Boolean | N | Y | Y | Should serial number validation be performed. Default: false. |
||||||
serial-number | String | N | Y | Y | Serial number of the device, in case serial number validation is enabled. |
||||||
configuration-update-type | enum(configuration-update-type) | N | Y | Y | Should the configuration be updated manually or automatically. Possible Values:
Default: AUTOMATIC. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this active-users node in the current node context. |
@total | Integer | Y | Y | N | Total number of active-users in the API result set. |
active-user | active-users. | N | Y | Y * |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | N | Link to this activeUser node in the current node context. Hyperlink Template: /api/space/user-management/active-users/{*ID}. |
@href | String(URI) | Y | Y | N | N | N | Link to an external activeUser. Hyperlink Template: /api/space/user-management/active-users/{*ID}. |
@total | Integer | Y | Y | N | N | N | Total number of gen_active-users-active-users in the API result set. Default: 0. |
domain-name | String | Y | Y | N | N | N | Domain Name. |
job-status | String | Y | Y | N | N | N | Job Status. |
job-id | Integer | Y | Y | N | N | N | Job ID. |
session-start-time | String | Y | Y | N | Y | Y | Session Start Time. |
id | Integer | Y | Y | N | Y | Y | ActiveUser ID. |
ip-address | String | Y | Y | N | Y | Y | User IP Addr. |
user-name | String | Y | Y | N | Y | Y | User Name. |
fabric-node-name | String | Y | Y | N | Y | Y | Fabric Node Name. |
session-duration | String | Y | Y | N | N | N | Login Duration. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | N | Y | Y | Link to this active-user-session node in the current node context. |
id | Integer | N | Y | Y | The HREF ID for this session. |
user-name | String | N | Y | Y * | The Session user name. |
ip-address | String | N | Y | Y * | The user's source address. |
session-start-time | String | N | Y | Y * | The time when the session was started. |
fabric-node-name | String | N | Y | Y * | user logged-in node name. |
user | active-user-session. | N | Y | Y * | The user for this session. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@href | String(URI) | N | Y | Y * | Link to an external user. |
@uri | String(URI) | N | Y | Y | Link to this user node in the current node context. |
id | Integer | N | Y | Y | The unique identifier for the user. |
name | String | N | Y | Y | The user's name. |
primaryEmail | String | N | Y | Y | The user's primary email. |
firstName | String | N | Y | Y | The user's first name. |
lastName | String | N | Y | Y | The user's last name. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | N | Y | Y * | Link to this active-user-sessions node in the current node context. |
@size | Integer | N | Y | Y * | The size of records returned by the API. |
@total | Integer | N | Y | Y * | Total number of active-user-sessions in the API result set. |
active-user-session | active-user-sessions. | N | Y | Y * | A single session. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
id | Integer | N | Y | Y | Y | Y | A unique identifier for the user session. |
user-name | String | N | Y | Y | N | N | The user name of the active session. |
domain-name | String | N | Y | Y | N | N | Domain name of the active session. |
ip-address | String | N | Y | Y | Y | Y | The IP address of the user session. |
session-start-time | String | N | Y | Y | N | N | The session start time of the active session. |
session-duration | String | N | Y | Y | N | N | The session duration of the active session. |
fabric-node-name | String | N | Y | Y | Y | Y | user logged-in node name. |
uri | String | N | Y | Y | N | N | The URI link to this active user session. |
href | String | N | Y | Y | N | N | The HREF link to this active user session. |
jobId | int | N | Y | Y | N | N | The Job Id to this active user session. |
jobStatus | String | N | Y | Y | N | N | The Job Status to this active user session. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
users-name-list | active-user-sessions-by-names-request. | N | Y | Y |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this usersNameLists node in the current node context. |
users-name-list | String[] | N | Y | Y * | Users Name Lists. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this add-database-fabric-node-request node in the current node context. |
primary-node | add-database-fabric-node-request. | N | Y | Y * | Information about the primary Database Node which has to be added to the fabric. |
vip | add-database-fabric-node-request. | N | Y | Y * | The VIP IP address of the Database Node. |
secondary-node | add-database-fabric-node-request. | N | Y | Y * | Information about the secondary Database Node which has to be added to the fabric. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this primaryNodeInfo node in the current node context. |
username | String | N | Y | Y * | The login user name used by the Junos Space server to login to Space Node while adding the node to the fabric. |
password | String | N | Y | Y * | The login password used by the Junos Space server to login to Space Node while adding the node to the fabric. |
name | String | N | Y | Y * | Name of the node. |
ip | String | N | Y | Y * | The IPv4 / IPv6 address of the node. |
fingerprint | String | N | Y | Y | Fingerprint of the node. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this virtualIP node in the current node context. |
ip-v4-address | String | N | Y | Y | IPv4 VIP address. |
ip-v6-address | String | N | Y | Y | IPv6 VIP address. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this secondaryNodeInfo node in the current node context. |
username | String | N | Y | Y * | The login user name used by the Junos Space server to login to Space Node while adding the node to the fabric. |
password | String | N | Y | Y * | The login password used by the Junos Space server to login to Space Node while adding the node to the fabric. |
name | String | N | Y | Y * | Name of the node. |
ip | String | N | Y | Y * | The IPv4 / IPv6 address of the node. |
fingerprint | String | N | Y | Y | Fingerprint of the node. |
Field Name | Type | Read Only | GET | PUT / POST | Description | ||||||
---|---|---|---|---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this add-device-discovery-rule-by-csv-request node in the current node context. |
||||||
id | Integer | Y | Y | N | DeviceDiscoveryRuleByCSV ID. |
||||||
discovery-profile-name | String | N | Y | Y * | Discovery profile name. |
||||||
target-details | String | N | Y | Y * | Target details (10. |
||||||
use-ping | Boolean | N | Y | Y * | usePing flag. Default: false. |
||||||
use-nat | Boolean | N | Y | Y * | useNAT flag. Default: false. |
||||||
sharable | Boolean | N | Y | Y | Profile sharable status. Default: true. |
||||||
use-snmp | Boolean | N | Y | Y * | useSnmp flag. Default: false. |
||||||
device-targets | add-device-discovery-rule-by-csv-request. | N | Y | Y * | |||||||
device-snmp-details | add-device-discovery-rule-by-csv-request. | N | Y | Y * | |||||||
device-snmp-version | enum(device-snmp-version) | N | Y | Y * | SNMP version. Possible Values:
|
||||||
discovery-action-additional-params | add-device-discovery-rule-by-csv-request. | N | Y | Y | Discovery Action additional parameter. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this deviceTargets node in the current node context. Hyperlink Template: /device-targets. |
device-target | add-device-discovery-rule-by-csv-request. | N | Y | Y * |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | N | Link to this deviceTarget node in the current node context. |
id | Integer | Y | Y | N | N | N | Id of device Target. |
device-ssh-credentials | add-device-discovery-rule-by-csv-request. | N | Y | Y | N | N | |
upper-ip | String | N | Y | Y * | N | N | upper ip address of a network to be discovered. |
device-fingerprints | add-device-discovery-rule-by-csv-request. | N | Y | Y | N | N | |
lower-ip | String | N | Y | Y * | N | N | Lower ip address of a network to be discovered. |
host-name | String | N | Y | Y * | N | N | Host name of device to be discovered. |
subnet-mask | String | N | Y | Y * | N | N | Sub-net mask of the above mentioned network. |
base-ip | String | N | Y | Y * | N | N | Network ip of a network to be discovered. |
tags | add-device-discovery-rule-by-csv-request. | N | Y | Y | N | N | |
ip-address | String | N | Y | Y * | N | N | ip-address of device to be discovered. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this deviceSshCredentials node in the current node context. |
@total | Integer | Y | Y | N | Total number of gen_add-device-discovery-rule-by-csv-request-device-targets-device-targets-device-ssh-credentials in the API result set. |
device-ssh-credential | add-device-discovery-rule-by-csv-request. | N | Y | Y * |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description | ||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | N | Link to this deviceSshCredential node in the current node context. |
||||||
id | Integer | Y | Y | N | N | N | Device credential id. |
||||||
username | String | N | Y | Y * | N | N | Name of user on the node used for authentication while discovery. |
||||||
pass-phrase | String | N | Y | Y | N | N | Pass Phrase. |
||||||
credential-type | enum(credential-type) | N | Y | Y | N | N | Credential Type. Possible Values:
|
||||||
private-key | String | N | Y | Y | N | N | Private Key. |
||||||
keybased | Boolean | N | Y | Y * | N | N | True to enable key-based authentication. Default: false. |
||||||
password | String | N | Y | Y * | N | N | Password for authentication. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this deviceFingerprints node in the current node context. |
@total | Integer | Y | Y | N | Total number of gen_add-device-discovery-rule-by-csv-request-device-targets-device-targets-device-fingerprints in the API result set. |
device-fingerprint | add-device-discovery-rule-by-csv-request. | N | Y | Y * |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | N | Link to this deviceTargetFingerprint node in the current node context. |
id | Integer | Y | Y | N | N | N | Id of the finger print entity. |
host-name | String | N | Y | Y * | N | N | Name of the node. |
fingerprint | String | N | Y | Y * | N | N | device fingerprint. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this tagLists node in the current node context. |
tag | String[] | N | Y | Y * | Tag name. |
Field Name | Type | Read Only | GET | PUT / POST | Description | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this deviceSnmpDetail node in the current node context. |
||||||||||
authentication-password | String | N | Y | Y * | Password for SNMPv3 authentication. |
||||||||||
id | Integer | Y | Y | N | Device SNMP details id. |
||||||||||
privacy-password | String | N | Y | Y * | key word to be used for encryption. |
||||||||||
snmpv1v2c-community | String | N | Y | Y * | SNMPV1/V2C Community name. |
||||||||||
user-name | String | N | Y | Y * | SNMPV3 username. |
||||||||||
snmp-auth-type | enum(snmp-auth-type) | N | Y | Y * | Authentication type of SNMPv3 Possible values : MD5, SHA1 or NONE;. Possible Values:
|
||||||||||
privacy-type | enum(privacy-type) | N | Y | Y * | Encryption methods to be used while discovery
Possible values: AES128, AES192, AES256, DES or NONE. Possible Values:
|
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this discoveryActionParams node in the current node context. |
discovery-action-additional-param | add-device-discovery-rule-by-csv-request. | N | Y | Y * | Discovery Action additional parameter. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | N | Link to this discoveryTriggerActionParam node in the current node context. |
parameter | String | N | Y | Y * | N | N | Parameter will act as a key. |
parameter-value | String | N | Y | Y * | N | N | ParameterValue will act as a value for the key. |
Field Name | Type | Read Only | GET | PUT / POST | Description | ||||||
---|---|---|---|---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this add-device-discovery-rule-by-host-name-request node in the current node context. |
||||||
id | Integer | Y | Y | N | DeviceDiscoveryRuleByHostName ID. |
||||||
discovery-profile-name | String | N | Y | Y * | Discovery profile name. |
||||||
use-ping | Boolean | N | Y | Y * | usePing flag. Default: false. |
||||||
use-nat | Boolean | N | Y | Y * | useNAT flag. Default: false. |
||||||
sharable | Boolean | N | Y | Y * | Profile sharable status. Default: true. |
||||||
use-snmp | Boolean | N | Y | Y * | useSnmp flag. Default: false. |
||||||
device-targets | add-device-discovery-rule-by-host-name-request. | N | Y | Y * | |||||||
device-snmp-details | add-device-discovery-rule-by-host-name-request. | N | Y | Y * | |||||||
device-snmp-version | enum(device-snmp-version) | N | Y | Y * | SNMP version. Possible Values:
|
||||||
discovery-action-additional-params | add-device-discovery-rule-by-host-name-request. | N | Y | Y | Discovery Action additional parameter configuration. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this deviceTargets node in the current node context. |
device-target | add-device-discovery-rule-by-host-name-request. | N | Y | Y * |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | N | Link to this deviceTarget node in the current node context. |
id | Integer | Y | Y | N | N | N | Id of device Target. |
host-name | String | N | Y | Y * | N | N | Host name of device to be discovered. |
device-ssh-credentials | add-device-discovery-rule-by-host-name-request. | N | Y | Y | N | N | |
device-fingerprints | add-device-discovery-rule-by-host-name-request. | N | Y | Y | N | N |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this deviceSshCredentials node in the current node context. |
@total | Integer | Y | Y | N | Total number of gen_add-device-discovery-rule-by-host-name-request-device-targets-device-targets-device-ssh-credentials in the API result set. |
device-ssh-credential | add-device-discovery-rule-by-host-name-request. | N | Y | Y * |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description | ||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | N | Link to this deviceSshCredential node in the current node context. |
||||||
id | Integer | Y | Y | N | N | N | Device credential id. |
||||||
username | String | N | Y | Y * | N | N | Name of user on the node used for authentication while discovery. |
||||||
keybased | Boolean | N | Y | Y * | N | N | True to enable key-based authentication. Default: false. |
||||||
credential-type | enum(credential-type) | N | Y | Y | N | N | Credential Type. Possible Values:
|
||||||
password | String | N | Y | Y * | N | N | Password for authentication. |
||||||
pass-phrase | String | N | Y | Y | N | N | Pass Phrase. |
||||||
private-key | String | N | Y | Y | N | N | Private Key. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this deviceFingerprints node in the current node context. |
@total | Integer | Y | Y | N | Total number of gen_add-device-discovery-rule-by-host-name-request-device-targets-device-targets-device-fingerprints in the API result set. |
device-fingerprint | add-device-discovery-rule-by-host-name-request. | N | Y | Y * |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | N | Link to this deviceTargetFingerprint node in the current node context. |
id | Integer | Y | Y | N | N | N | Id of the finger print entity. |
host-name | String | N | Y | Y * | N | N | Name of the node. |
fingerprint | String | N | Y | Y * | N | N | device fingerprint. |
Field Name | Type | Read Only | GET | PUT / POST | Description | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this deviceSnmpDetail node in the current node context. |
||||||||||
authentication-password | String | N | Y | Y * | Password for SNMPv3 authentication. |
||||||||||
id | Integer | Y | Y | N | Device SNMP details id. |
||||||||||
privacy-password | String | N | Y | Y * | key word to be used for encryption. |
||||||||||
snmpv1v2c-community | String | N | Y | Y * | SNMPV1/V2C Community name. |
||||||||||
user-name | String | N | Y | Y * | SNMPV3 username. |
||||||||||
snmp-auth-type | enum(snmp-auth-type) | N | Y | Y * | Authentication type of SNMPv3 Possible values : MD5, SHA1 or NONE;. Possible Values:
|
||||||||||
privacy-type | enum(privacy-type) | N | Y | Y * | Encryption methods to be used while discovery
Possible values: AES128, AES192, AES256, DES or NONE. Possible Values:
|
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this discoveryActionParams node in the current node context. |
discovery-action-additional-param | add-device-discovery-rule-by-host-name-request. | N | Y | Y * | Discovery Action additional parameter. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | N | Link to this discoveryTriggerActionParam node in the current node context. |
parameter | String | N | Y | Y * | N | N | Parameter will act as a key. |
parameter-value | String | N | Y | Y * | N | N | ParameterValue will act as a value for the key. |
Field Name | Type | Read Only | GET | PUT / POST | Description | ||||||
---|---|---|---|---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this add-device-discovery-rule-by-ip-hostname-request node in the current node context. |
||||||
id | Integer | Y | Y | N | DeviceDiscoveryRuleByIPHostname ID. |
||||||
target-details | String | N | Y | Y | Target details (10. |
||||||
discovery-profile-name | String | N | Y | Y * | Discovery profile name. |
||||||
use-ping | Boolean | N | Y | Y * | usePing flag. Default: false. |
||||||
use-nat | Boolean | N | Y | Y * | useNAT flag. Default: false. |
||||||
sharable | Boolean | N | Y | Y | Profile sharable status. Default: true. |
||||||
use-snmp | Boolean | N | Y | Y * | useSnmp flag. Default: false. |
||||||
device-targets | add-device-discovery-rule-by-ip-hostname-request. | N | Y | Y * | |||||||
device-snmp-version | enum(device-snmp-version) | N | Y | Y * | SNMP version. Possible Values:
|
||||||
device-snmp-details | add-device-discovery-rule-by-ip-hostname-request. | N | Y | Y * |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this deviceTargets node in the current node context. Hyperlink Template: /device-targets. |
device-target | add-device-discovery-rule-by-ip-hostname-request. | N | Y | Y * |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | N | Link to this deviceTarget node in the current node context. |
id | Integer | Y | Y | N | N | N | Id of device Target. |
base-ip | String | N | Y | Y * | N | N | Network ip of a network to be discovered. |
subnet-mask | String | N | Y | Y * | N | N | Sub-net mask of the above mentioned network. |
ip-address | String | N | Y | Y * | N | N | ip-address of device to be discovered. |
host-name | String | N | Y | Y * | N | N | Host name of device to be discovered. |
device-ssh-credentials | add-device-discovery-rule-by-ip-hostname-request. | N | Y | Y | N | N | |
lower-ip | String | N | Y | Y * | N | N | Lower ip address of a network to be discovered. |
upper-ip | String | N | Y | Y * | N | N | upper ip address of a network to be discovered. |
device-fingerprints | add-device-discovery-rule-by-ip-hostname-request. | N | Y | Y | N | N |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this deviceSshCredentials node in the current node context. Hyperlink Template: /device-targets/device-ssh-credentials. |
@total | Integer | Y | Y | N | Total number of gen_add-device-discovery-rule-by-ip-hostname-request-device-targets-device-targets-device-ssh-credentials in the API result set. |
device-ssh-credential | add-device-discovery-rule-by-ip-hostname-request. | N | Y | Y * |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description | ||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | N | Link to this deviceSshCredential node in the current node context. |
||||||
id | Integer | Y | Y | N | N | N | Device credential id. |
||||||
username | String | N | Y | Y * | N | N | Name of user on the node used for authentication while discovery. |
||||||
keybased | Boolean | N | Y | Y * | N | N | True to enable key-based authentication. Default: false. |
||||||
credential-type | enum(credential-type) | N | Y | Y | N | N | Credential Type. Possible Values:
|
||||||
password | String | N | Y | Y * | N | N | Password for authentication. |
||||||
pass-phrase | String | N | Y | Y | N | N | Pass Phrase. |
||||||
private-key | String | N | Y | Y | N | N | Private Key. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this deviceFingerprints node in the current node context. Hyperlink Template: /device-targets/device-fingerprints. |
@total | Integer | Y | Y | N | Total number of gen_add-device-discovery-rule-by-ip-hostname-request-device-targets-device-targets-device-fingerprints in the API result set. |
device-fingerprint | add-device-discovery-rule-by-ip-hostname-request. | N | Y | Y * |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | N | Link to this deviceTargetFingerprint node in the current node context. |
id | Integer | Y | Y | N | N | N | Id of the finger print entity. |
fingerprint | String | N | Y | Y * | N | N | device fingerprint. |
host-name | String | N | Y | Y * | N | N | Name of the node. |
Field Name | Type | Read Only | GET | PUT / POST | Description | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this deviceSnmpDetail node in the current node context. |
||||||||||
authentication-password | String | N | Y | Y * | Password for SNMPv3 authentication. |
||||||||||
id | Integer | Y | Y | N | Device SNMP details id. |
||||||||||
privacy-password | String | N | Y | Y * | key word to be used for encryption. |
||||||||||
snmpv1v2c-community | String | N | Y | Y * | SNMPV1/V2C Community name. |
||||||||||
user-name | String | N | Y | Y * | SNMPV3 username. |
||||||||||
snmp-auth-type | enum(snmp-auth-type) | N | Y | Y * | Authentication type of SNMPv3 Possible values : MD5, SHA1 or NONE;. Possible Values:
|
||||||||||
privacy-type | enum(privacy-type) | N | Y | Y * | Encryption methods to be used while discovery
Possible values: AES128, AES192, AES256, DES or NONE. Possible Values:
|
Field Name | Type | Read Only | GET | PUT / POST | Description | ||||||
---|---|---|---|---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this add-device-discovery-rule-by-ip-range-request node in the current node context. |
||||||
id | Integer | Y | Y | N | DeviceDiscoveryRuleByIPRange ID. |
||||||
discovery-profile-name | String | N | Y | Y * | Discovery profile name. |
||||||
use-ping | Boolean | N | Y | Y * | usePing flag. Default: false. |
||||||
use-nat | Boolean | N | Y | Y * | useNAT flag. Default: false. |
||||||
sharable | Boolean | N | Y | Y * | Profile sharable status. Default: true. |
||||||
use-snmp | Boolean | N | Y | Y * | useSnmp flag. Default: false. |
||||||
device-targets | add-device-discovery-rule-by-ip-range-request. | N | Y | Y * | |||||||
device-snmp-details | add-device-discovery-rule-by-ip-range-request. | N | Y | Y * | |||||||
device-snmp-version | enum(device-snmp-version) | N | Y | Y * | SNMP version. Possible Values:
|
||||||
discovery-action-additional-params | add-device-discovery-rule-by-ip-range-request. | N | Y | Y | Discovery Action additional parameter configuration. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this deviceTargets node in the current node context. |
device-target | add-device-discovery-rule-by-ip-range-request. | N | Y | Y * |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | N | Link to this deviceTarget node in the current node context. |
id | Integer | Y | Y | N | N | N | Id of device Target. |
lower-ip | String | N | Y | Y * | N | N | Lower ip address of a network to be discovered. |
upper-ip | String | N | Y | Y * | N | N | upper ip address of a network to be discovered. |
device-ssh-credentials | add-device-discovery-rule-by-ip-range-request. | N | Y | Y | N | N | |
device-fingerprints | add-device-discovery-rule-by-ip-range-request. | N | Y | Y | N | N |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this deviceSshCredentials node in the current node context. |
@total | Integer | Y | Y | N | Total number of gen_add-device-discovery-rule-by-ip-range-request-device-targets-device-targets-device-ssh-credentials in the API result set. |
device-ssh-credential | add-device-discovery-rule-by-ip-range-request. | N | Y | Y * |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description | ||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | N | Link to this deviceSshCredential node in the current node context. |
||||||
id | Integer | Y | Y | N | N | N | Device credential id. |
||||||
username | String | N | Y | Y * | N | N | Name of user on the node used for authentication while discovery. |
||||||
keybased | Boolean | N | Y | Y * | N | N | True to enable key-based authentication. Default: false. |
||||||
credential-type | enum(credential-type) | N | Y | Y | N | N | Credential Type. Possible Values:
|
||||||
password | String | N | Y | Y * | N | N | Password for authentication. |
||||||
pass-phrase | String | N | Y | Y | N | N | Pass Phrase. |
||||||
private-key | String | N | Y | Y | N | N | Private Key. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this deviceFingerprints node in the current node context. |
@total | Integer | Y | Y | N | Total number of gen_add-device-discovery-rule-by-ip-range-request-device-targets-device-targets-device-fingerprints in the API result set. |
device-fingerprint | add-device-discovery-rule-by-ip-range-request. | N | Y | Y * |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | N | Link to this deviceTargetFingerprint node in the current node context. |
id | Integer | Y | Y | N | N | N | Id of the finger print entity. |
host-name | String | N | Y | Y * | N | N | Name of the node. |
fingerprint | String | N | Y | Y * | N | N | device fingerprint. |
Field Name | Type | Read Only | GET | PUT / POST | Description | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this deviceSnmpDetail node in the current node context. |
||||||||||
authentication-password | String | N | Y | Y * | Password for SNMPv3 authentication. |
||||||||||
id | Integer | Y | Y | N | Device SNMP details id. |
||||||||||
privacy-password | String | N | Y | Y * | key word to be used for encryption. |
||||||||||
snmpv1v2c-community | String | N | Y | Y * | SNMPV1/V2C Community name. |
||||||||||
user-name | String | N | Y | Y * | SNMPV3 username. |
||||||||||
snmp-auth-type | enum(snmp-auth-type) | N | Y | Y * | Authentication type of SNMPv3 Possible values : MD5, SHA1 or NONE;. Possible Values:
|
||||||||||
privacy-type | enum(privacy-type) | N | Y | Y * | Encryption methods to be used while discovery
Possible values: AES128, AES192, AES256, DES or NONE. Possible Values:
|
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this discoveryActionParams node in the current node context. |
discovery-action-additional-param | add-device-discovery-rule-by-ip-range-request. | N | Y | Y * | Discovery Action additional parameter. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | N | Link to this discoveryTriggerActionParam node in the current node context. |
parameter | String | N | Y | Y * | N | N | Parameter will act as a key. |
parameter-value | String | N | Y | Y * | N | N | ParameterValue will act as a value for the key. |
Field Name | Type | Read Only | GET | PUT / POST | Description | ||||||
---|---|---|---|---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this add-device-discovery-rule-by-ip-request node in the current node context. |
||||||
id | Integer | Y | Y | N | DeviceDiscoveryRuleByIp ID. |
||||||
discovery-profile-name | String | N | Y | Y * | Discovery profile name. |
||||||
use-ping | Boolean | N | Y | Y * | usePing flag. Default: false. |
||||||
use-nat | Boolean | N | Y | Y * | useNAT flag. Default: false. |
||||||
sharable | Boolean | N | Y | Y | Profile sharable status. Default: true. |
||||||
use-snmp | Boolean | N | Y | Y * | useSnmp flag. Default: false. |
||||||
device-targets | add-device-discovery-rule-by-ip-request. | N | Y | Y | |||||||
device-snmp-details | add-device-discovery-rule-by-ip-request. | N | Y | Y * | |||||||
device-snmp-version | enum(device-snmp-version) | N | Y | Y * | SNMP version. Possible Values:
|
||||||
discovery-action-additional-params | add-device-discovery-rule-by-ip-request. | N | Y | Y | Discovery Action additional parameter configuration. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this deviceTargets node in the current node context. Hyperlink Template: /device-targets. |
device-target | add-device-discovery-rule-by-ip-request. | N | Y | Y * |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | N | Link to this deviceTarget node in the current node context. |
id | Integer | Y | Y | N | N | N | Id of device Target. |
ip-address | String | N | Y | Y * | N | N | ip-address of device to be discovered. |
device-ssh-credentials | add-device-discovery-rule-by-ip-request. | N | Y | Y | N | N | |
device-fingerprints | add-device-discovery-rule-by-ip-request. | N | Y | Y | N | N |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this deviceSshCredentials node in the current node context. Hyperlink Template: /device-ssh-credentials. |
@total | Integer | Y | Y | N | Total number of gen_add-device-discovery-rule-by-ip-request-add-device-discovery-rule-by-ip-request-device-targets-device-targets-device-ssh-credentials in the API result set. |
device-ssh-credential | add-device-discovery-rule-by-ip-request. | N | Y | Y * |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description | ||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | N | Link to this deviceSshCredential node in the current node context. |
||||||
id | Integer | Y | Y | N | N | N | Device credential id. |
||||||
username | String | N | Y | Y * | N | N | Name of user on the node used for authentication while discovery. |
||||||
keybased | Boolean | N | Y | Y * | N | N | True to enable key-based authentication. Default: false. |
||||||
credential-type | enum(credential-type) | N | Y | Y | N | N | Credential Type. Possible Values:
|
||||||
password | String | N | Y | Y * | N | N | Password for authentication. |
||||||
pass-phrase | String | N | Y | Y | N | N | Pass Phrase. |
||||||
private-key | String | N | Y | Y | N | N | Private Key. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this deviceFingerprints node in the current node context. Hyperlink Template: /device-fingerprints. |
@total | Integer | Y | Y | N | Total number of gen_add-device-discovery-rule-by-ip-request-add-device-discovery-rule-by-ip-request-device-targets-device-targets-device-fingerprints in the API result set. |
device-fingerprint | add-device-discovery-rule-by-ip-request. | N | Y | Y * |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | N | Link to this deviceTargetFingerprint node in the current node context. |
id | Integer | Y | Y | N | N | N | Id of the finger print entity. |
host-name | String | N | Y | Y * | N | N | Name of the node. |
fingerprint | String | N | Y | Y * | N | N | device fingerprint. |
Field Name | Type | Read Only | GET | PUT / POST | Description | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this deviceSnmpDetail node in the current node context. |
||||||||||
authentication-password | String | N | Y | Y * | Password for SNMPv3 authentication. |
||||||||||
id | Integer | Y | Y | N | Device SNMP details id. |
||||||||||
privacy-password | String | N | Y | Y * | key word to be used for encryption. |
||||||||||
snmpv1v2c-community | String | N | Y | Y * | SNMPV1/V2C Community name. |
||||||||||
user-name | String | N | Y | Y * | SNMPV3 username. |
||||||||||
snmp-auth-type | enum(snmp-auth-type) | N | Y | Y * | Authentication type of SNMPv3 Possible values : MD5, SHA1 or NONE;. Possible Values:
|
||||||||||
privacy-type | enum(privacy-type) | N | Y | Y * | Encryption methods to be used while discovery
Possible values: AES128, AES192, AES256, DES or NONE. Possible Values:
|
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this discoveryActionParams node in the current node context. |
discovery-action-additional-param | add-device-discovery-rule-by-ip-request. | N | Y | Y * | Discovery Action additional parameter. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | N | Link to this discoveryTriggerActionParam node in the current node context. |
parameter | String | N | Y | Y * | N | N | Parameter will act as a key. |
parameter-value | String | N | Y | Y * | N | N | ParameterValue will act as a value for the key. |
Field Name | Type | Read Only | GET | PUT / POST | Description | ||||||
---|---|---|---|---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this add-device-discovery-rule-by-ip-subnet-request node in the current node context. |
||||||
id | Integer | Y | Y | N | DeviceDiscoveryRuleByIPSubnet ID. |
||||||
discovery-profile-name | String | N | Y | Y * | Discovery profile name. |
||||||
use-ping | Boolean | N | Y | Y * | usePing flag. Default: false. |
||||||
use-nat | Boolean | N | Y | Y * | useNAT flag. Default: false. |
||||||
sharable | Boolean | N | Y | Y * | Profile sharable status. Default: true. |
||||||
use-snmp | Boolean | N | Y | Y * | useSnmp flag. Default: false. |
||||||
device-targets | add-device-discovery-rule-by-ip-subnet-request. | N | Y | Y * | |||||||
device-snmp-details | add-device-discovery-rule-by-ip-subnet-request. | N | Y | Y * | |||||||
device-snmp-version | enum(device-snmp-version) | N | Y | Y * | SNMP version. Possible Values:
|
||||||
discovery-action-additional-params | add-device-discovery-rule-by-ip-subnet-request. | N | Y | Y | Discovery Action additional parameter configuration. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this deviceTargets node in the current node context. |
device-target | add-device-discovery-rule-by-ip-subnet-request. | N | Y | Y * |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | N | Link to this deviceTarget node in the current node context. |
id | Integer | Y | Y | N | N | N | Id of device Target. |
base-ip | String | N | Y | Y * | N | N | Network ip of a network to be discovered. |
subnet-mask | String | N | Y | Y * | N | N | Sub-net mask of the above mentioned network. |
device-ssh-credentials | add-device-discovery-rule-by-ip-subnet-request. | N | Y | Y | N | N | |
device-fingerprints | add-device-discovery-rule-by-ip-subnet-request. | N | Y | Y | N | N |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this deviceSshCredentials node in the current node context. |
@total | Integer | Y | Y | N | Total number of gen_add-device-discovery-rule-by-ip-subnet-request-device-targets-device-targets-device-ssh-credentials in the API result set. |
device-ssh-credential | add-device-discovery-rule-by-ip-subnet-request. | N | Y | Y * |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description | ||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | N | Link to this deviceSshCredential node in the current node context. |
||||||
id | Integer | Y | Y | N | N | N | Device credential id. |
||||||
username | String | N | Y | Y * | N | N | Name of user on the node used for authentication while discovery. |
||||||
keybased | Boolean | N | Y | Y * | N | N | True to enable key-based authentication. Default: false. |
||||||
credential-type | enum(credential-type) | N | Y | Y | N | N | Credential Type. Possible Values:
|
||||||
password | String | N | Y | Y * | N | N | Password for authentication. |
||||||
pass-phrase | String | N | Y | Y | N | N | Pass Phrase. |
||||||
private-key | String | N | Y | Y | N | N | Private Key. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this deviceFingerprints node in the current node context. |
@total | Integer | Y | Y | N | Total number of gen_add-device-discovery-rule-by-ip-subnet-request-device-targets-device-targets-device-fingerprints in the API result set. |
device-fingerprint | add-device-discovery-rule-by-ip-subnet-request. | N | Y | Y * |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | N | Link to this deviceTargetFingerprint node in the current node context. |
id | Integer | Y | Y | N | N | N | Id of the finger print entity. |
host-name | String | N | Y | Y * | N | N | Name of the node. |
fingerprint | String | N | Y | Y * | N | N | device fingerprint. |
Field Name | Type | Read Only | GET | PUT / POST | Description | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this deviceSnmpDetail node in the current node context. |
||||||||||
authentication-password | String | N | Y | Y * | Password for SNMPv3 authentication. |
||||||||||
id | Integer | Y | Y | N | Device SNMP details id. |
||||||||||
privacy-password | String | N | Y | Y * | key word to be used for encryption. |
||||||||||
snmpv1v2c-community | String | N | Y | Y * | SNMPV1/V2C Community name. |
||||||||||
user-name | String | N | Y | Y * | SNMPV3 username. |
||||||||||
snmp-auth-type | enum(snmp-auth-type) | N | Y | Y * | Authentication type of SNMPv3 Possible values : MD5, SHA1 or NONE;. Possible Values:
|
||||||||||
privacy-type | enum(privacy-type) | N | Y | Y * | Encryption methods to be used while discovery
Possible values: AES128, AES192, AES256, DES or NONE. Possible Values:
|
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this discoveryActionParams node in the current node context. |
discovery-action-additional-param | add-device-discovery-rule-by-ip-subnet-request. | N | Y | Y * | Discovery Action additional parameter. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | N | Link to this discoveryTriggerActionParam node in the current node context. |
parameter | String | N | Y | Y * | N | N | Parameter will act as a key. |
parameter-value | String | N | Y | Y * | N | N | ParameterValue will act as a value for the key. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this add-jboss-fabric-node-request node in the current node context. |
password | String | N | Y | Y * | The login password used by the Junos Space server to login to Space Node while adding the node to the fabric. |
ip | String | N | Y | Y * | The IPv4 / IPv6 address of the node. |
username | String | N | Y | Y * | The login user name used by the Junos Space server to login to Space Node while adding the node to the fabric. |
name | String | N | Y | Y * | Name of the node. |
fingerprint | String | N | Y | Y | Fingerprint of the node. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this add-more-devices-request node in the current node context. Hyperlink Template: /api/space/device-management/modeled-device-management/modeled-instances/{*ID}. |
tag-name | String | N | Y | Y | Tag devices with this tag. |
device-count | Integer | N | Y | Y * | Number of devices, This will be overridden if deviceUnits are explicitly defined. |
devices | add-more-devices-request. | N | Y | Y | List of modeled device which contains details like device-name, platform, os-version, serial-number. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this deviceUnitsMOColls node in the current node context. Hyperlink Template: /api/space/device-management/modeled-device-management/modeled-instances/{*ID}/devices. |
@total | Integer | Y | Y | N | Total number of gen_deploy-instance-device-units-mo-coll in the API result set. |
device | add-more-devices-request. | N | Y | Y | Modeled device which contains details like device-name, platform, os-version, serial-number. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | N | Link to this deployDeviceUnit node in the current node context. |
device-name | String | N | Y | Y | N | N | Name of the device unit. |
platform | String | N | Y | Y | N | N | The platform of the device. |
os-version | String | N | Y | Y | N | N | OS version of the device unit. |
serial-number | String | N | Y | Y | N | N | Serial Number of device unit. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this add-secondary-database-fabric-node-request node in the current node context. |
secondary-node | add-secondary-database-fabric-node-request. | N | Y | Y * | Information about the secondary Database Node which has to be added to the fabric. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this secondaryNodeInfo node in the current node context. |
username | String | N | Y | Y * | The login user name used by the Junos Space server to login to Space Node while adding the node to the fabric. |
password | String | N | Y | Y * | The login password used by the Junos Space server to login to Space Node while adding the node to the fabric. |
name | String | N | Y | Y * | Name of the node. |
ip | String | N | Y | Y * | The IPv4 / IPv6 address of the node. |
fingerprint | String | N | Y | Y | Fingerprint of the node. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this add-special-fabric-node-request node in the current node context. |
ip | String | N | Y | Y * | The IPv4 / IPv6 address of the node. |
name | String | N | Y | Y * | Name of the node. |
user-name | String | N | Y | Y | The login user name used by the Junos Space server to login to Special Node while adding the node to the fabric. If this is not provided then while adding the node to the fabric Junos Space server will try to connect to the node without credentials. |
password | String | N | Y | Y | The login password used by the Junos Space server to login to Special Node while adding the node to the fabric. |
fingerprint | String | N | Y | Y | Fingerprint of the node. |
Field Name | Type | Read Only | GET | PUT / POST | PATCH | Description |
---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | Link to this api-access-profile node in the current node context. Hyperlink Template: /api/space/user-management/api-access-profiles/{*ID}. |
@href | String(URI) | Y | Y | N | N | Link to an external api-access-profile. Hyperlink Template: /api/space/user-management/api-access-profiles/{*ID}. |
*id | Integer | Y | Y | N | N | Id of the api access profile. |
name | String | N | Y | Y * | Y | Name of the api access profile. |
description | String | N | Y | Y * | Y | Description for the api access profile. |
predefined | Boolean | Y | Y | N | N | This flag is used to define whether this api access profile is predefined or not. Default: false. |
exec-rpc-rules | api-access-profile. | N | Y | Y * | Y | |
domain-id | Integer | Y | Y | N | N | Domain ID. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this rpcRules node in the current node context. |
exec-rpc-rule | api-access-profile. | N | Y | Y * |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | N | Link to this aPIRPCRule node in the current node context. |
rule | String | N | Y | Y * | N | N | RPC restriction rule. |
Field Name | Type | Read Only | GET | PUT / POST | PATCH | Description |
---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | Link to this api-access-profiles node in the current node context. |
@total | Integer | Y | Y | N | N | Total number of api-access-profiles in the API result set. |
api-access-profile | api-access-profiles. | N | Y | Y * | Y |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | N | Link to this aPIAccessProfile node in the current node context. Hyperlink Template: /api/space/user-management/api-access-profiles/{*ID}. |
@href | String(URI) | Y | Y | N | N | N | Link to an external api-access-profile. Hyperlink Template: /api/space/user-management/api-access-profiles/{*ID}. |
id | Integer | Y | Y | N | N | N | Id of the api access profile. |
name | String | N | Y | Y * | Y | Y | Name of the api access profile. |
description | String | N | Y | Y * | Y | Y | Description for the api access profile. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this applicable-configlets node in the current node context. |
@total | Integer | Y | Y | N | Total number of applicable-configlets in the API result set. |
applicable-configlet | applicable-configlets. | N | Y | Y * | Configlet that is applicable for the Device Family. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description | ||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
@href | String(URI) | Y | Y | N | N | N | Link to an external cliConfigurationTemplate. Hyperlink Template: /api/space/configuration-management/cli-configlets/{*ID}. |
||||||
id | Integer | Y | Y | N | N | N | Configlet ID Unique key of the configlet. |
||||||
name | String | Y | Y | N | Y | Y | Configlet Name The name of the configlet and it cannot exceed 255 characters. You cannot have two configlets with the same name in one domain and if this configlet have to be included by other configlets via #mixin directive, then configlet name should not have SPACE and DOT(. |
||||||
category | String | Y | Y | N | Y | Y | Category Category for which the configlet belongs to and this is an arbitrary value, which can be used for filtering. The Category cannot exceed 255 characters. |
||||||
device-family | String | Y | Y | N | Y | Y | Device Family The device family for which the configlet will be applicable for. |
||||||
latest-version | String | Y | Y | N | Y | Y | Latest Version Latest version of the configlet. |
||||||
last-modified-by | String | Y | Y | N | Y | Y | Last Modified user The name of the user who modified the configlet at last. |
||||||
creation-time | Date | Y | Y | N | Y | Y | Creation Time The time when the configlet was created. |
||||||
description | String | Y | Y | N | N | N | Description Description of the configlet and it cannot exceed 2500 characters. |
||||||
execution-type | String | Y | Y | N | Y | Y | Types of Execution There are two types of execution types.
|
||||||
last-updated-time | Date | Y | Y | N | Y | Y | Last Modified Time The time when the configlet was updated at last. |
||||||
domain-id | Integer | Y | Y | N | N | Y | Domain ID ID of the domain for which the configlet belongs to. |
||||||
domain-name | String | Y | Y | N | N | N | Domain Name Name of the domain for which the Cli-Configlet belongs to. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this applicable-devices node in the current node context. |
@total | Integer | Y | Y | N | Total number of applicable-devices in the API result set. |
applicable-device | applicable-devices. | N | Y | Y * | A Device (excluding Unmanaged/Modeled Device) to which the Configlet is applicable. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@href | String(URI) | Y | Y | N | N | N | Link to an external device. Hyperlink Template: /api/space/device-management/devices/{*ID}. |
id | Integer | Y | Y | N | Y | Y | Device ID Unique key of the Device to which the configlet is applicable. |
name | String | Y | Y | N | Y | Y | Device Name Name of the Device for which the configlet is applicable. |
ip-address | String | Y | Y | N | Y | Y | IP Address IP Address of the Device to which the configlet is applicable. |
serial-number | String | Y | Y | N | Y | Y | Serial Number Serial Number of the Device to which the configlet is applicable. |
connection-status | String | Y | Y | N | Y | Y | Connection Status Connection Status of the Device to which the configlet is applicable. |
managed-status | String | Y | Y | N | Y | Y | Managed Status Managed Status of the Device to which the configlet is applicable. |
device-family | String | Y | Y | N | Y | Y | Device Family Family type of the Device to which the configlet is applicable. |
platform | String | Y | Y | N | Y | Y | Platform Platform of the Device to which the configlet is applicable. |
os-version | String | Y | Y | N | Y | Y | OS Version OS Version of the Device to which the configlet is applicable. |
domain-id | Integer | Y | Y | N | N | Y | Domain ID ID of the Domain to which the Device belongs to. |
domain-name | String | Y | Y | N | N | N | Domain Name Name of the Domain to which the Device belongs to. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this application node in the current node context. Hyperlink Template: /api/space/application-management/applications/{*ID}. |
@href | String(URI) | Y | Y | N | Link to an external application. Hyperlink Template: /api/space/application-management/applications/{*ID}. |
vendor-id | String | N | Y | Y * | Vendor ID. |
*id | Integer | Y | Y | N | Application ID. |
name | String | Y | Y | N | Application Name. |
domain-id | Integer | Y | Y | N | Application's Domain ID. |
title | String | Y | Y | N | Application Title. |
app-version | String | Y | Y | N | Application Version. |
app-sub-version | String | Y | Y | N | Application Sub-Version. |
release-type | String | Y | Y | N | Application Release Type. |
description | String | Y | Y | N | Application Description. |
domain-name | String | Y | Y | N | Application's Domain Name. |
min-platform-version | String | Y | Y | N | Minimum Platform Version which supports this application. |
server-group | String | Y | Y | N | Name of server group on which the application is deployed. |
settings | String | Y | Y | N | config settings for application Hyperlink Template: /api/space/application-management/applications/{*ID}/settings-config. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | N | Y | Y | Link to this application node in the current node context. |
id | Integer | N | Y | Y * |
Unique identifier for the application. |
appName | String | N | Y | Y * |
Name of the application. |
appVersion | String | N | Y | Y * |
Version of the application. |
appSubVersion | String | N | Y | Y |
Sub-version of the application. |
title | String | N | Y | Y * |
Title of the application. |
description | String | N | Y | Y * |
Description of the application. |
releaseType | String | N | Y | Y |
Type of release for the application. |
vendorId | String | N | Y | Y |
Unique identifier for the application vendor. |
vendorName | String | N | Y | Y |
Name of the application vendor. |
settings | String | N | Y | Y * |
Configuration settings for the application. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this applications node in the current node context. |
@total | Integer | Y | Y | N | Total number of applications in the API result set. |
application | applications. | N | Y | Y * |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | N | Link to this application node in the current node context. Hyperlink Template: /api/space/application-management/applications/{*ID}. |
@href | String(URI) | Y | Y | N | N | N | Link to an external application. Hyperlink Template: /api/space/application-management/applications/{*ID}. |
id | Integer | Y | Y | N | N | N | Application ID. |
name | String | Y | Y | N | Y | Y | Application Name. |
domain-id | Integer | Y | Y | N | N | Y | Application's Domain ID. |
release-type | String | Y | Y | N | N | N | Application Release Type. |
title | String | Y | Y | N | Y | Y | Application Title. |
description | String | Y | Y | N | N | N | Application Description. |
app-version | String | Y | Y | N | Y | Y | Application Version. |
app-sub-version | String | Y | Y | N | Y | N | Application Sub-Version. |
min-platform-version | String | Y | Y | N | N | N | Minimum Platform Version which supports this application. |
domain-name | String | Y | Y | N | N | N | Application's Domain Name. |
server-group | String | Y | Y | N | N | N | Name of server group on which the application is deployed. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | N | Y | Y | Link to this applications node in the current node context. |
@size | Integer | N | Y | Y |
Total number of applications available in the system. |
application | applications. | N | Y | Y * |
A collection of applications. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@uri | String(URI) | N | Y | Y | N | N | Link to this jSApplicationConfig node in the current node context. |
@href | String(URI) | N | Y | Y | N | N | Link to an external jSApplicationConfig. |
id | Integer | N | Y | Y * | N | N | Unique identifier for an application |
appName | String | N | Y | Y * | N | N | Name of the application |
appVersion | String | N | Y | Y * | Y | Y | Version of the application |
title | String | N | Y | Y * | Y | Y | Title of the application |
description | String | N | Y | Y * | N | N | Description of the application |
releaseType | String | N | Y | Y | N | N | Type of release for the application |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this apply-cli-configlet node in the current node context. |
configlet | apply-cli-configlet. | N | Y | Y * | Configlet details. |
cli-configlet-params | apply-cli-configlet. | N | Y | Y | Configlet parameter details. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this cliConfigurationTemplate node in the current node context. |
@href | String(URI) | N | Y | Y * | Link to an external cliConfigurationTemplate. Hyperlink Template: /api/space/configuration-management/cli-configlets/{*ID}. |
id | Integer | Y | Y | N | Unique key of the configlet. |
name | String | Y | Y | N | Name of the configlet The Name cannot exceed 255 characters. You cannot have two configlets with the same name. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this cliConfigletParams node in the current node context. |
cli-configlet-param | apply-cli-configlet. | N | Y | Y * | Configlet parameter. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | N | Link to this configletParamForNBI node in the current node context. |
parameter | apply-cli-configlet. | N | Y | Y * | N | N | Parameter details. |
parameter-value | String | N | Y | Y * | N | N | Parameter Value. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this paramForNBI node in the current node context. |
@href | String(URI) | N | Y | Y * | Link to an external paramForNBI. Hyperlink Template: /api/space/configuration-management/cli-configlets/{*ID}/cli-configlet-params/{*ID}. |
param-id | Integer | Y | Y | N | Configlet Parameter ID Unique Id for the configlet parameter. Default: 0. Default: 0. |
name | String | Y | Y | N | Parameter Name Name of the parameter. |
configlet-id | Integer | Y | Y | N | Configlet ID Unique Id for the configlet. |
Field Name | Type | Read Only | GET | PUT / POST | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this apply-cli-configlet-job-result node in the current node context. Hyperlink Template: /api/space/configuration-management/apply-cli-configlet-job-results/{*ID}. |
||||||||||||||||
@href | String(URI) | Y | Y | N | Link to an external apply-cli-configlet-job-result. Hyperlink Template: /api/space/configuration-management/apply-cli-configlet-job-results/{*ID}. |
||||||||||||||||
applied-configuration | String | N | Y | Y * | Applied Configuration. |
||||||||||||||||
status-string | String | N | Y | Y * | Status String. |
||||||||||||||||
end-time | Date | N | Y | Y | End Time. |
||||||||||||||||
cli-template-name | String | N | Y | Y * | Cli Template Name. |
||||||||||||||||
params-detailss | apply-cli-configlet-job-result. | N | Y | Y | Collection of Configlet Parameters applied on the Device. |
||||||||||||||||
*id | Integer | Y | Y | N | Job result table row ID. |
||||||||||||||||
start-time | Date | N | Y | Y * | Start Time. |
||||||||||||||||
cli-configlet-mgmt-job-status | enum(cli-configlet-mgmt-job-status) | N | Y | Y * | Cli Configlet Mgmt Job Status. Possible Values:
|
||||||||||||||||
post-configuration | Boolean | N | Y | Y * | Post Configuration. Default: false. |
||||||||||||||||
category | String | N | Y | Y * | Category. |
||||||||||||||||
device-name | String | N | Y | Y * | Device Name. |
||||||||||||||||
cli-template-id | Integer | N | Y | Y * | Cli Template ID. |
||||||||||||||||
description | String | N | Y | Y | Description. |
||||||||||||||||
job-remarks | String | N | Y | Y * | Job Remarks. |
||||||||||||||||
context | String | N | Y | Y * | Context. |
||||||||||||||||
postparameters | Boolean | N | Y | Y * | Postparameters. Default: false. |
||||||||||||||||
job-percentage-completed | Double | N | Y | Y * | Job Percentage Completed. |
||||||||||||||||
job-instance-id | Integer | N | Y | Y * | Job Instance ID. |
||||||||||||||||
device-id | Integer | N | Y | Y * | Device ID. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this paramsDetailsses node in the current node context. Hyperlink Template: /api/space/configuration-management/apply-cli-configlet-job-results/{*ID}/params-detailss. |
applied-params-details | apply-cli-configlet-job-result. | N | Y | Y * | Configlet Parameters applied on the Device. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | N | Link to this appliedParamsDetails node in the current node context. |
param-value | String | N | Y | Y * | N | N | Param Value. |
param-name | String | N | Y | Y * | N | N | Param Name. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this apply-cli-configlet-job-results node in the current node context. |
@total | Integer | Y | Y | N | Total number of apply-cli-configlet-job-results in the API result set. |
apply-cli-configlet-job-result | apply-cli-configlet-job-results. | N | Y | Y * | Apply cli configlet job result detail. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | N | Link to this applyCLIConfigletJobResult node in the current node context. Hyperlink Template: /api/space/configuration-management/apply-cli-configlet-job-results/{*ID}. |
||||||||||||||||
id | Integer | Y | Y | N | N | N | Job result table row ID. |
||||||||||||||||
job-status | enum(job-status) | Y | Y | N | Y | Y | Status of this job - same as status on the job. Possible Values:
|
||||||||||||||||
applied-configuration | String | Y | Y | N | N | N | Configuration applied on the device. |
||||||||||||||||
cli-template-name | String | Y | Y | N | Y | Y | Cli Template Name. |
||||||||||||||||
params | apply-cli-configlet-job-results. | Y | Y | N | N | N | Collection of Configlet Parameters. |
||||||||||||||||
post-configuration | Boolean | Y | Y | N | N | N | Post Configuration. Default: false. |
||||||||||||||||
category | String | Y | Y | N | N | N | Category. |
||||||||||||||||
device-name | String | Y | Y | N | Y | Y | Device Name. |
||||||||||||||||
cli-template-id | Integer | Y | Y | N | Y | Y | Cli Template ID. |
||||||||||||||||
description | String | Y | Y | N | N | N | Description. |
||||||||||||||||
job-remarks | String | Y | Y | N | Y | Y | Job Remarks. |
||||||||||||||||
context | String | Y | Y | N | N | N | XPath to device configuration context. |
||||||||||||||||
post-parameters | Boolean | Y | Y | N | N | N | Post Parameters. Default: false. |
||||||||||||||||
job-percentage-completed | Double | Y | Y | N | N | N | Job Percentage Completed. |
||||||||||||||||
job-id | Integer | Y | Y | N | N | N | Job ID. |
||||||||||||||||
device-id | Integer | Y | Y | N | N | N | Device ID. |
||||||||||||||||
device | String | Y | Y | N | N | N | Device Link Hyperlink Template: /api/space/device-management/devices/{*ID}. |
||||||||||||||||
job | String | Y | Y | N | N | N | Job Link Hyperlink Template: /api/space/job-management/jobs/{*ID}. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this paramsDetailsMOs node in the current node context. |
@total | Integer | Y | Y | N | Total number of gen_apply-cli-configlet-job-results-apply-cli-configlet-job-results-params-details-mos in the API result set. |
param | apply-cli-configlet-job-results. | N | Y | Y * | Configlet Parameter. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | N | Link to this appliedParamsDetails node in the current node context. |
param-value | String | N | Y | Y * | N | N | Param Value. |
param-name | String | N | Y | Y * | N | N | Param Name. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this apply-cli-configlet-request node in the current node context. |
device | apply-cli-configlet-request. | N | Y | Y * | Device details. |
context | String | N | Y | Y | The XPATH context. |
cli-configlet-params | apply-cli-configlet-request. | N | Y | Y | List of Configlet Parameters. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@href | String(URI) | N | Y | Y * | Link to an external device. Hyperlink Template: /api/space/device-management/devices/{*ID}. |
id | Integer | Y | Y | N | Device ID Unique ID of the device through this device can be fetched. |
name | String | Y | Y | N | Device Name. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this cliConfigletParams node in the current node context. |
cli-configlet-param | apply-cli-configlet-request. | N | Y | Y * | Configlet Parameters Configlet parameters which will be applied in configlet configuration and if value of the configlet parameter is not specified then default value or evaluated value by xpath would be considered. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | N | Link to this configletParamForNBI node in the current node context. |
parameter | apply-cli-configlet-request. | N | Y | Y * | N | N | Parameter Details of the parameter. |
parameter-value | String | N | Y | Y * | N | N | Parameter Value Value of the parameter to be applied in configlet configuration. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@href | String(URI) | N | Y | Y * | Link to an external paramForNBI. Hyperlink Template: /api/space/configuration-management/cli-configlets/{*ID}/cli-configlet-params/{*ID}. |
param-id | Integer | Y | Y | N | Configlet Parameter ID Unique key of the configlet parameter ID. Default: 0. |
name | String | Y | Y | N | Parameter Name Name of the parameter. |
configlet-id | Integer | Y | Y | N | Configlet ID Unique ID for the configlet. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this archive-purge-audit-logs-by-age-request node in the current node context. |
purge-days | Long | N | Y | Y | The number of days which is used as the criteria to select audit logs for purge operation. Default: 90. |
purge-from-all-domains | Boolean | N | Y | Y | The boolean value which is used to determine whether
the audtit logs has to be purged from all the RBAC Domains the user has access to. The default value is "false". Default: false. |
archive-before-purge | Boolean | N | Y | Y | The boolean value indicating whether the audit logs has to be archived before purge. The audit logs will be archived either in Junos space server in the path "/var/lib/mysql/archive" or to a remote SCP server if the "archive-info" in specified. Default: true. |
remote-archive-info | archive-purge-audit-logs-by-age-request. | N | Y | Y | The Information about the remote SCP server where the archived audit logs will be stored. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this auditlogArchive node in the current node context. |
user-name | String | N | Y | Y * | The user name which will be used by the Junos space server during login
to the remote SCP server to store the archive file. |
password | String | N | Y | Y * | The password which will be used by the Junos space server during login
to the remote SCP server to store the archive file. |
remote-ip | String | N | Y | Y * | The IP of the remote SCP server in which the Junos space server will store the archive file. |
archive-path | String | N | Y | Y * | The path in the remote SCP server where the Junos space server will store the archive file. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this archive-purge-audit-logs-by-time-request node in the current node context. |
purge-time | Long | N | Y | Y * | The time which is used as the criteria to select audit logs for purge operation. |
purge-from-all-domains | Boolean | N | Y | Y | The boolean value which is used to determine whether
the audtit logs has to be purged from all the RBAC Domains the user has access to. The default value is "false". Default: false. |
archive-before-purge | Boolean | N | Y | Y | The boolean value indicating whether the audit logs has to be archived before purge. The audit logs will be archived either in Junos space server in the path "/var/lib/mysql/archive" or to a remote SCP server if the "archive-info" in specified. Default: true. |
remote-archive-info | archive-purge-audit-logs-by-time-request. | N | Y | Y | The Information about the remote SCP server where the archived audit logs will be stored. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this auditlogArchive node in the current node context. |
user-name | String | N | Y | Y * | The user name which will be used by the Junos space server during login
to the remote SCP server to store the archive file. |
password | String | N | Y | Y * | The password which will be used by the Junos space server during login
to the remote SCP server to store the archive file. |
remote-ip | String | N | Y | Y * | The IP of the remote SCP server in which the Junos space server will store the archive file. |
archive-path | String | N | Y | Y * | The path in the remote SCP server where the Junos space server will store the archive file. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this archive-purge-jobs-local-request node in the current node context. |
purge-from-all-domains | Boolean | N | Y | Y * | Purge From All Domains. |
archive-jobs-before | Long | N | Y | Y * | Job which triggered before this date will be archived. |
job-type | String | N | Y | Y * | Type of job to be purge
List of types are available under /api/space/job-management/job-types. Default: "All". |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this archive-purge-jobs-remote-request node in the current node context. |
archive-jobs-before | Long | N | Y | Y * | Job which triggered before this date will be archived. |
job-type | String | N | Y | Y * | Type of job to be purge
List of types are available under /api/space/job-management/job-types. Default: "All". |
purge-from-all-domains | Boolean | N | Y | Y * | Purge From All Domains. |
user | String | N | Y | Y * | user name of remote machine to remote authentication. |
password | String | N | Y | Y * | Password for the above mentioned user to remote authentication. |
ip | String | N | Y | Y * | ip of the machine in which the archive files will be stored. |
path | String | N | Y | Y * | file path to save archive files
Note: This should end with /. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
devices | assign-devices. | N | Y | Y * |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this devices node in the current node context. |
device | assign-devices. | N | Y | Y * |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@href | String(URI) | N | Y | Y * | N | N | Link to an external device. Hyperlink Template: /api/space/device-management/devices/{*ID}. |
id | Integer | Y | Y | N | Y | Y | Device ID. |
name | String | Y | Y | N | Y | Y | Device Name. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this assign-devices-job-results node in the current node context. |
@total | Integer | Y | Y | N | Total number of assign-devices-job-results in the API result set. |
assign-devices-job-result | assign-devices-job-results. | N | Y | Y * |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description | ||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | N | Link to this assignDevicesResult node in the current node context. |
||||||
id | Integer | Y | Y | N | N | N | Job result table row ID. |
||||||
assign-device-status | enum(assign-device-status) | N | Y | Y * | Y | Y | Device assignment to domain status(Can be any one of FAILURE, SUCCESS or INPROGRESS). Possible Values:
|
||||||
hostname | String | N | Y | Y * | Y | Y | Hostname of the device. |
||||||
assign-description | String | N | Y | Y * | Y | N | Failure reason for the device assignment failure. |
||||||
device-id | Integer | N | Y | Y * | Y | Y | device id. |
||||||
ip | String | N | Y | Y * | Y | N | IP address of the device. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this associated-devices node in the current node context. |
@total | Integer | Y | Y | N | Total number of associated-devices in the API result set. |
device | associated-devices. | N | Y | Y * |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description | ||||
---|---|---|---|---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | N | Link to this deviceImageValidation node in the current node context. Hyperlink Template: /api/space/software-management/packages/{*ID}/associated-devices. |
||||
@href | String(URI) | N | Y | Y * | N | N | Link to an external deviceImageValidation. Hyperlink Template: /api/space/device-management/devices/{*ID}. |
||||
checksum-status | enum(checksum-status) | N | Y | Y | N | N | Possible Values:
|
||||
checksum-time | String | N | Y | Y | N | N | |||||
ip-addr | String | N | Y | Y | N | N | |||||
device-name | String | N | Y | Y | N | N | |||||
device-id | Integer | N | Y | Y | N | N |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this associated-devices node in the current node context. |
@total | Integer | Y | Y | N | Total number of associated-devices in the API result set. |
associated-device | associated-devices. | N | Y | Y * | A collection of Devices associated with the Software Package. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description | ||||
---|---|---|---|---|---|---|---|---|---|---|---|
@href | String(URI) | N | Y | Y * | N | N | Link to an external deviceImageAssociation. Hyperlink Template: /api/space/device-management/devices/{*ID}. |
||||
@uri | String(URI) | Y | Y | N | N | N | Link to this deviceImageAssociation node in the current node context. Hyperlink Template: /api/space/software-management/packages/{*ID}/associated-devices/{*ID}. |
||||
checksum-status | enum(checksum-status) | Y | Y | N | Y | Y | States whether or not the Software Package staged on the Device is Valid. Possible Values:
|
||||
device-name | String | Y | Y | N | N | N | Name of the Device associated with the Software Package. |
||||
deployed-status | enum(deployed-status) | Y | Y | N | N | N | States whether or not the Software Package is Deployed on the Device. Possible Values:
|
||||
checksum-time | Date | Y | Y | N | Y | Y | Time at which the Software Package staged on the Device is validated. |
||||
staged-status | enum(staged-status) | Y | Y | N | Y | Y | States whether or not the Software Package is Staged on the Device. Possible Values:
Default: NOTSTAGED. |
||||
device-id | Integer | Y | Y | N | N | N | ID of the Device associated with the Software Package. |
||||
ip-address | String | Y | Y | N | N | N | IP Address of the Device associated with the Software Package. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | N | Y | Y | Link to this associated-scripts node in the current node context. |
@size | Integer | N | Y | Y | Total number of results available |
script-device-association | associated-scripts. | N | Y | Y * |
The collection of associations. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description | ||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
script | associated-scripts. | N | Y | Y * | N | N | The script metadata (that is, script ID, name, and type). |
||||||
script-category | String | N | Y | Y * | Y | Y |
Category of the script. |
||||||
deployed-version | String | N | Y | Y * | N | N | The script deployed version | ||||||
device-name | String | N | Y | Y * | N | N | The name of the device | ||||||
script-status | enum(script-status) | N | Y | Y * | N | N |
The script status
Possible Values:
|
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@href | String(URI) | N | Y | Y | Link to an external script. |
@uri | String(URI) | N | Y | Y | Link to this script node in the current node context. |
script-id | Long | N | Y | Y * |
The script's ID. |
script-name | String | N | Y | Y * | The name of the script |
script-type | String | N | Y | Y * |
The script status, which is either enabled or disabled. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this associated-softwares node in the current node context. |
@total | Integer | Y | Y | N | Total number of associated-softwares in the API result set. |
associated-software | associated-softwares. | N | Y | Y * | A collection of Software Packages associated with the Device. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description | ||||
---|---|---|---|---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | N | Link to this deviceImageValidation node in the current node context. Hyperlink Template: /api/space/software-management/packages/{*ID}. |
||||
@href | String(URI) | N | Y | Y * | N | N | Link to an external deviceImageValidation. Hyperlink Template: /api/space/software-management/packages/{*ID}. |
||||
checksum-status | enum(checksum-status) | N | Y | Y | N | N | States whether or not the Software Package staged on the Device is Valid. Possible Values:
|
||||
checksum-time | String | N | Y | Y | N | N | Time at which the Software Package staged on the Device is validated. |
||||
software-file-name | String | N | Y | Y | N | N | Name of the Software Package associated with the Device. |
||||
software-id | Integer | Y | Y | N | N | N | ID of the Software Package associated with the Device. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | N | Y | Y | Link to this audit-log node in the current node context. |
record-http-get-method | Boolean | N | Y | Y * |
Indicates whether a record is returned. |
auditlog-forwarding-interval | Integer | N | Y | Y * |
Audit log forwarding interval in minutes. |
log-success-scenario | Boolean | N | Y | Y * |
Indicates whether a Log Successful Audit Log forwarding. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | N | Y | Y | Link to this audit-log node in the current node context. |
userName | String | N | Y | Y |
Contains the name of the user who accessed the API. |
userIpAddr | String | N | Y | Y |
Contains the IP of the user who accessed the API. |
description | String | N | Y | Y |
Contains the description of what the API did. |
logTime | String | N | Y | Y |
Contains the current server timestamp. |
applicationName | String | N | Y | Y |
Contains the constant 'REST' to represent that the record was logged by the REST API. |
taskName | String | N | Y | Y |
Contains the URI of the API. |
result | String | N | Y | Y |
Contains the HTTP status code returned to the user. |
domainId | Integer | N | Y | Y |
Contains the domain id of the audit log object. |
domainName | String | N | Y | Y | Contains the domain name of the audit log object |
job | audit-log. | N | Y | Y |
Contains the job information related to the API, if the API is asynchronous. |
object | audit-log. | N | Y | Y |
Contains the modified object's information related to the API, if the API is synchronous. |
workSpaceName | String | N | Y | Y | |
domain | String | Y | Y | N |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@href | String(URI) | N | Y | Y | Link to an external job. |
id | Integer | N | Y | Y | Job ID. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
link | audit-log. | N | Y | Y | N | N | Reference to modified object. |
object-name | String | N | Y | Y | N | N |
Field contains the name of modified object. |
object-detail | String | N | Y | Y | N | N | Modified Object Detail. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@href | String(URI) | N | Y | Y | Link to an external modifiedObjectLink. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | N | Y | Y | Link to this audit-logs node in the current node context. |
@size | Integer | N | Y | Y |
Contains the size of the collection of records. |
@total | Integer | N | Y | Y | Total number of audit-logs in the API result set. |
audit-log | audit-logs. | N | Y | Y |
Contains the record entries. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@uri | String(URI) | N | Y | Y | N | N | Link to this auditlogTO node in the current node context. |
@href | String(URI) | N | Y | Y | N | N | Link to an external auditlogTO. |
@key | Integer | N | Y | Y | N | N |
Contains the ID of the record. |
userName | String | N | Y | Y | N | N |
Contains the name of the user who accessed the API. |
userIpAddr | String | N | Y | Y | N | N |
Contains the IP of the user who accessed the API. |
description | String | N | Y | Y | N | N |
Contains the description of what the API did. |
logTime | String | N | Y | Y | N | N |
Contains the current server timestamp. |
workSpaceName | String | N | Y | Y | N | N |
Contains the workspace related information. |
applicationName | String | N | Y | Y | N | N |
Contains the constant 'REST' to represent that the record was logged by the REST API. |
taskName | String | N | Y | Y | Y | Y |
Contains the URI of the API. |
result | String | N | Y | Y | N | N |
Contains the HTTP status code returned to the user. |
jobId | int | N | Y | Y * | Y | Y |
Contains the job id information. |
domainId | int | N | Y | Y * | N | Y | |
domainName | String | N | Y | Y | N | N |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
device-ids | audit-template-config-version-request. | N | Y | Y * |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this deviceIDs node in the current node context. |
device-id | Integer[] | N | Y | Y * | Device IDs. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | N | Y | Y | Link to this authmode node in the current node context. |
auth-mode | String | N | Y | Y * |
Authentication Mode. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
jobs | cancel-jobs-request. | N | Y | Y * |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this instanceManagedObjects node in the current node context. |
job | cancel-jobs-request. | N | Y | Y * |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@href | String(URI) | N | Y | Y * | N | N | Link to an external monitorableTaskInstanceManagedObject. Hyperlink Template: /api/space/job-management/jobs/{*ID}. |
id | Integer | Y | Y | N | Y | Y | The ID of the job. |
name | String | Y | Y | N | N | N | MonitorableTaskInstanceManagedObject Name. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this capabilities node in the current node context. |
@total | Integer | Y | Y | N | Total number of capabilities in the API result set. |
capability | capabilities. | N | Y | Y * |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@href | String(URI) | N | Y | Y * | N | N | Link to an external capability. Hyperlink Template: /api/space/user-management/capabilities/{*ID}. |
id | Integer | Y | Y | N | N | N | ID. |
name | String | Y | Y | N | N | N | Name. |
title | String | Y | Y | N | N | N | Title. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | N | Y | Y * | Link to this capabilities node in the current node context. |
@size | Integer | N | Y | Y * |
The total number of capabilities available in the System. |
capability | capabilities. | N | Y | Y * |
The collection of objects of type 'capability'. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
key | Integer | N | Y | Y | N | N |
A unique identifier for the capability. |
name | String | N | Y | Y | Y | Y |
The name of the capability. |
uri | String | N | Y | Y | N | N |
A link to identify the 'capability' resource. |
href | String | N | Y | Y | N | N |
The location of the 'capability' resource. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | N | Y | Y * | Link to this capabilities-ref node in the current node context. |
@size | Integer | N | Y | Y |
The total number of capabilities associated with a role. |
capability | capabilities-ref. | N | Y | Y |
The collection of objects of type 'capability'. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
key | Integer | N | Y | Y | N | N |
The unique identifier for a capability. |
name | String | N | Y | Y | N | N |
The name of the capability. |
href | String | N | Y | Y | N | N |
The location of a capability. |
uri | String | N | Y | Y | N | N |
A link to identify the 'capability' resource. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | N | Y | Y * | Link to this capability node in the current node context. |
id | Integer | N | Y | Y * |
A unique identifier for the capability. |
name | String | N | Y | Y * |
The name of the capability. |
title | String | N | Y | Y |
The title of the capability. |
tasks | capability. | N | Y | Y |
The tasks associated with the capability. |
roles | capability. | N | Y | Y |
The roles associated with the capability. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
task | capability. | N | Y | Y |
The collection of objects of type 'capabilityTask'. |
uri | String | N | Y | Y |
A link to identify the tasks associated with a capability. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
id | Integer | N | Y | Y | N | N |
The unique identifier for a task. |
name | String | N | Y | Y | N | N |
The name of the task. |
href | String | N | Y | Y | N | N |
The location of a task. |
uri | String | N | Y | Y | N | N |
A link to identify the task associated with the capability. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
role | capability. | N | Y | Y |
The collection of objects of type 'capabilityRole'. |
uri | String | N | Y | Y |
A link to identify the roles associated with the capability. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
id | Integer | N | Y | Y | N | N |
The unique identifier for a role. |
name | String | N | Y | Y | N | N |
The name of the role. |
href | String | N | Y | Y | N | N |
The location of a role. |
uri | String | N | Y | Y | N | N |
A link to identify the role associated with the capability. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this capability-ref node in the current node context. Hyperlink Template: /api/space/user-management/roles/{*ID}/capabilities/{*ID}. |
@href | String(URI) | N | Y | Y * | Link to an external capability-ref. Hyperlink Template: /api/space/user-management/capabilities/{*ID}. |
id | Integer | Y | Y | N | Capability ID. |
name | String | Y | Y | N | Capability Name. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@key | Integer | N | Y | Y * |
A unique identifier for the capability. |
@href | String(URI) | N | Y | Y * | Link to an external capability-ref. |
@uri | String(URI) | N | Y | Y * | Link to this capability-ref node in the current node context. |
name | String | N | Y | Y * |
The name of the capability. |
title | String | N | Y | Y |
The title of the capability. |
Field Name | Type | Read Only | GET | PUT / POST | PATCH | Description |
---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | Link to this capability-refs node in the current node context. |
@total | Integer | Y | Y | N | N | Total number of capabilities in the API result set. |
capability | capability-refs. | N | Y | Y * | Y |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | N | Link to this capability node in the current node context. Hyperlink Template: /api/space/user-management/roles/{*ID}/capabilities/{*ID}. |
@href | String(URI) | N | Y | Y * | N | N | Link to an external capability. Hyperlink Template: /api/space/user-management/capabilities/{*ID}. |
id | Integer | Y | Y | N | N | N | Capability ID. |
name | String | Y | Y | N | N | N | Capability Name. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this catalog-configuration-response node in the current node context. |
current-hw-revision | String | N | Y | Y * | Current HW Revision. Default: "N/A". |
current-hw-published | String | N | Y | Y * | Current HW Published. Default: "N/A". |
current-hw-last-update | String | N | Y | Y * | Current HW Last Update. Default: "N/A". |
svn-hw-revision | String | N | Y | Y * | Svn HW Revision. |
svn-hw-published | String | N | Y | Y * | Svn HW Published. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@size | Integer | N | Y | Y |
Total number of categories. |
@uri | String(URI) | N | Y | Y | Link to this categories node in the current node context. |
category | categories. | N | Y | Y |
A collection of categories. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
@href | String(URI) | N | Y | Y | N | N | Link to an external category. |
||||||||||||||||
@uri | String(URI) | N | Y | Y | N | N | Link to this category node in the current node context. |
||||||||||||||||
@key | String | N | Y | Y | N | N |
Unique identifier for the category. |
||||||||||||||||
packageName | String | N | Y | Y | Y | N |
Name of package for the logging configuration. |
||||||||||||||||
priority | enum(priority) | N | Y | Y | Y | N |
Priority level for the logging configuration. Possible Values:
|
||||||||||||||||
handler | String | N | Y | Y | N | N | log file handler name. |
Field Name | Type | Read Only | GET | PUT / POST | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
packageName | String | N | Y | Y * |
Name of package for the logging configuration. |
||||||||||||||||
priority | enum(priority) | N | Y | Y |
Priority level for the logging configuration. Possible Values:
|
||||||||||||||||
handler | String | N | Y | Y | log file handler name. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this certificate node in the current node context. Hyperlink Template: /api/space/user-management/certificate. |
sig-alg-name | String | Y | Y | N | Sig Alg Name. |
domain-id | Integer | Y | Y | N | Domain ID. |
not-after | String | Y | Y | N | Not After. |
domain-name | String | Y | Y | N | Domain Name. |
cert-data | certificate. | N | Y | Y * | |
serial-number | String | Y | Y | N | Serial Number. |
cert-type | String | Y | Y | N | cert type could be PERSONAL or CA. |
last-update | Long | Y | Y | N | Last Update. |
not-before | String | Y | Y | N | Not Before. |
expire-time | Long | Y | Y | N | Expire Time. |
*id | Integer | Y | Y | N | X509Cert ID. |
name | String | Y | Y | N | X509Cert Name. |
crl-serials | String | Y | Y | N | Crl Serials. |
issuer-name | String | Y | Y | N | Issuer Name. |
raw-file-name | String | Y | Y | N | Raw File Name. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this certDatas node in the current node context. |
cert-data | Byte[] | N | Y | Y * | Cert Datas. |
Field Name | Type | Read Only | GET | PUT / POST | Description | ||||
---|---|---|---|---|---|---|---|---|---|
devices | change-credentials-request. | N | Y | Y * |
A collection of devices. |
||||
user-name | String | N | Y | Y * |
Credential user name. |
||||
password | String | N | Y | Y |
Credential password. |
||||
change-to | enum(change-to) | N | Y | Y * |
Authentication Type. Possible Values:
|
||||
change-on-device | Boolean | N | Y | Y |
Change credentials on devices. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
device | change-credentials-request. | N | Y | Y * |
A collection of devices. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@href | String(URI) | N | Y | Y * | Link to an external device. |
id | Integer | N | Y | Y |
Unique identifier for the 'device'. |
name | String | N | Y | Y | Name of the device |
Field Name | Type | Read Only | GET | PUT / POST | Description | ||||
---|---|---|---|---|---|---|---|---|---|
devices | change-credentials-request. | N | Y | Y * |
A collection of devices. |
||||
user-name | String | N | Y | Y * |
Credential user name. |
||||
password | String | N | Y | Y |
Credential password. |
||||
change-to | enum(change-to) | N | Y | Y |
Authentication Type. Possible Values:
|
||||
change-on-device | Boolean | N | Y | Y |
Change credentials on devices. |
||||
re-authenticate-device | Boolean | N | Y | Y |
Flag for Re-authenticate the connection to device. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
device | change-credentials-request. | N | Y | Y |
A collection of devices. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@href | String(URI) | N | Y | Y * | Link to an external device. |
id | Integer | N | Y | Y * |
Unique identifier for the 'device'. |
name | String | N | Y | Y | Name of the device |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
oldPassword | String | N | Y | Y * | The user's old password |
newPassword | String | N | Y | Y * | The user's new password |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
old-password | String | N | Y | Y * | Old Password. |
password-expiry-time | Date | N | Y | Y * | Password Expiry Time. |
email-password | Boolean | N | Y | Y * | Email Password. Default: false. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | N | Y | Y | Link to this change-request node in the current node context. |
id | Integer | N | Y | Y * |
A unique identifier for the change request. |
name | String | N | Y | Y |
Name of the change request. |
description | String | N | Y | Y |
Description for the change request. |
xmlData | String | N | Y | Y |
The configuration data needed for the change request. |
device | change-request. | N | Y | Y * |
The representation of the device. |
syncAfterPush | Boolean | N | Y | Y |
Whether to re-synchronize the device after the configuration update or not. |
result | String | N | Y | Y | Result of the change request deployment to the device. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@href | String(URI) | N | Y | Y | Link to an external device. |
id | Long | N | Y | Y |
Unique identifier for the device. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | N | Y | Y * | Link to this change-requests node in the current node context. |
@size | Integer | N | Y | Y * |
Total number of change-requests available in the System. |
@total | Integer | N | Y | Y * | Total number of change-requests in the API result set. |
change-request | change-requests. | N | Y | Y |
The collection of objects of type 'change-request'. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@href | String(URI) | N | Y | Y * | N | N | Link to an external changeRequestDO. |
@uri | String(URI) | N | Y | Y * | N | N | Link to this changeRequestDO node in the current node context. |
@key | Integer | N | Y | Y * | N | N |
Unique identifier for the change-request. |
deviceId | Long | N | Y | Y * | N | N |
The device identifier corresponding to the change request. |
name | String | N | Y | Y | Y | Y |
Name of the change request. |
description | String | N | Y | Y | Y | Y |
The description for the change request. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | N | Y | Y | Link to this change-requests node in the current node context. |
change-request | change-requests. | N | Y | Y | A single change request. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@href | String(URI) | N | Y | Y | N | N | Link to an external changeRequestDO. |
id | Integer | N | Y | Y * | N | N |
A unique identifier for the change request. |
name | String | N | Y | Y | N | N |
Name of the change request. |
description | String | N | Y | Y | Y | Y |
Description for the change request. |
xmlData | String | N | Y | Y | N | N |
The configuration data needed for the change request. |
device | change-requests. | N | Y | Y * | N | N |
The representation of the device. |
syncAfterPush | Boolean | N | Y | Y | N | N |
Whether to re-synchronize the device after the configuration update or not. |
result | change-requests. | N | Y | Y | N | N | Result of change request deployment to the device. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@href | String(URI) | N | Y | Y | Link to an external device. |
id | Long | N | Y | Y |
Unique identifier for the device. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
status | String | N | Y | Y | Status of change request deployment. |
message | String | N | Y | Y | Message (if any) from the device after a change request deployment. |
rpc-reply | String | N | Y | Y | Complete rpc-reply message. |
changeReqId | Integer | N | Y | Y | Change request ID. |
syncAfterPush | Boolean | N | Y | Y | Synchronize device configuration to Junos Space after a change request deployment. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | N | Y | Y * | Link to this change-requests node in the current node context. |
@size | Integer | N | Y | Y * |
Total number of change-requests available in the system. |
@total | Integer | N | Y | Y * | Total number of change-requests in the API result set. |
change-request | change-requests. | N | Y | Y |
A collection of change requests. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@href | String(URI) | N | Y | Y * | N | N | Link to an external changeRequest. |
@key | Integer | N | Y | Y * | N | N |
Unique identifier for the 'change-request'. |
deviceId | Long | N | Y | Y | N | N |
Unique identifier for the device on which the change-request was submitted. |
name | String | N | Y | Y | Y | Y |
Name of the change-request. |
description | String | N | Y | Y | Y | Y | Description of change-request |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this children node in the current node context. |
@total | Integer | Y | Y | N | Total number of domains in the API result set. |
domain | children. | N | Y | Y * |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@href | String(URI) | Y | Y | N | N | N | Link to an external domain. Hyperlink Template: /api/space/domain-management/domains/{*ID}. |
@uri | String(URI) | Y | Y | N | N | N | Link to this domain node in the current node context. Hyperlink Template: /api/space/domain-management/domains/{*ID}/children/{*ID}. |
description | String | N | Y | Y * | N | N | Description added by user. |
id | Integer | N | Y | Y * | N | N | ID of domain. |
name | String | N | Y | Y * | N | N | Name of the domain. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
users | clear-local-passwords-request. | N | Y | Y * |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this users node in the current node context. |
user | clear-local-passwords-request. | N | Y | Y * | Get all users. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@href | String(URI) | N | Y | Y * | N | N | Link to an external user. Hyperlink Template: /api/space/user-management/users/{*ID}. |
id | Integer | Y | Y | N | Y | Y | User ID. |
name | String | Y | Y | N | Y | Y | User Name. |
Field Name | Type | Read Only | GET | PUT / POST | PATCH | Description | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | Link to this cli-configlet node in the current node context. Hyperlink Template: /api/space/configuration-management/cli-configlets/{*ID}. |
||||||||||
@href | String(URI) | Y | Y | N | N | Link to an external cli-configlet. Hyperlink Template: /api/space/configuration-management/cli-configlets/{*ID}. |
||||||||||
*id | Integer | Y | Y | N | N | Configlet ID This is the unique key value used to access/identify the specific configlet. |
||||||||||
name | String | N | Y | Y * | Y | Configlet Name The Name cannot exceed 255 characters. You cannot have two configlets with the same name in one domain. |
||||||||||
latest-version | String | Y | Y | N | N | Latest Version Latest version of the configlet. Default: "1.0". |
||||||||||
category | String | N | Y | Y | Y | Category Category for which the configlet belongs to and this is an arbitrary value, which can be used for filtering. The Category cannot exceed 255 characters. |
||||||||||
description | String | N | Y | Y | Y | Description Description of the configlet and it cannot exceed 2500 characters. |
||||||||||
context | String | N | Y | Y | Y | Context The context for which the configlet would be applicable for. i. Example :
|
||||||||||
reference-number | Integer | N | Y | Y | Y | Reference Number Reference Number is an arbitrary value which can be used for filtering the configlet. Min: 1 Max: 65535. |
||||||||||
device-family | String | N | Y | Y * | Y | Device Family The device family for which the configlet will be applicable for. |
||||||||||
execution-type | enum(execution-type) | N | Y | Y | Y | Types of Execution There are two types of execution types.
Possible Values:
Default: SINGLE. |
||||||||||
preview-show-parameters | Boolean | N | Y | Y | Y | Pre-view Show Parameters Setting this option as true enables user to view the configlet parameter's details before applying the configlet. Default: true. |
||||||||||
preview-show-configuration | Boolean | N | Y | Y | Y | Pre-view Show Configuration Setting this option as true enables user to view the consolidated configuration to be applied before applying the configlet. Default: true. |
||||||||||
postview-show-parameters | Boolean | N | Y | Y | Y | Post view Show Parameters Setting this option as true enables user to view applied configlet parameter's details after applying the configlet. Default: true. |
||||||||||
postview-show-configuration | Boolean | N | Y | Y | Y | Post-view Show Configuration Setting this option as true enables user to view applied consolidated configuration after applying the configlet. Default: true. |
||||||||||
domain-id | Integer | Y | Y | N | N | Domain ID It specifies the domain ID for which this configlet belongs to. |
||||||||||
domain-name | String | Y | Y | N | N | Domain Name Name of the domain for which the configlet belongs to. |
||||||||||
creation-time | Date | Y | Y | N | N | Creation Time The time when the configlet was created. |
||||||||||
last-updated-time | Date | Y | Y | N | N | Last Modified Time The time when the configlet was updated at last. |
||||||||||
last-modified-by | String | Y | Y | N | N | Last Modified user The name of the user who modified the configlet at last. |
||||||||||
cli-text | String | N | Y | Y * | Y | Configlet content The actual configlet configuration is configured here The syntax of the configlet could be as VTL template(https://velocity. |
||||||||||
cli-configlet-params | cli-configlet. | N | Y | Y | Y | List of Configlet parameter's details. |
||||||||||
compute-parameter-values | String | Y | Y | N | N | This API is used to compute(retrieve) parameter values based on the xpaths defined in that parameter of the configle. Hyperlink Template: /api/space/configuration-management/cli-configlets/{*ID}/compute-parameter-values. |
||||||||||
apply-cli-configlet | String | Y | Y | N | N | This API is used to apply a configlet on the device Hyperlink Template: /api/space/configuration-management/cli-configlets/{*ID}/apply-cli-configlet. |
||||||||||
submit-cli-configlet | String | Y | Y | N | N | This API is used to apply a configlet on the device Hyperlink Template: /api/space/configuration-management/cli-configlets/{*ID}/submit-cli-configlet. |
||||||||||
applicable-devices | String | Y | Y | N | N | This API is used to get the devices for which the configlet is applicable Hyperlink Template: /api/space/configuration-management/cli-configlets/{*ID}/applicable-devices. |
||||||||||
validate-cli-configlet | String | Y | Y | N | N | This API is used to validate a configlet on the device Hyperlink Template: /api/space/configuration-management/cli-configlets/{*ID}/validate-cli-configlet. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this templateParams node in the current node context. Hyperlink Template: /api/space/configuration-management/cli-configlets/{*ID}/cli-configlet-params. |
@total | Integer | Y | Y | N | Total number of gen_cli-configlet-template-params in the API result set. |
cli-configlet-param | cli-configlet. | N | Y | Y * | Configlet parameter details. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description | ||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | N | Link to this cliTemplateAdvanceConfig node in the current node context. |
||||||||||||||||||||||||||||||||||
id | Integer | Y | Y | N | N | N | Configlet Parameter ID Unique key for the parameter of the configlet. |
||||||||||||||||||||||||||||||||||
parameter | String | N | Y | Y * | N | N | Parameter Name The name of the parameter as used in the configlet. |
||||||||||||||||||||||||||||||||||
display-name | String | N | Y | Y * | N | N | Display Name User friendly name for the parameter. |
||||||||||||||||||||||||||||||||||
description | String | N | Y | Y | N | N | Description Description for the parameter. |
||||||||||||||||||||||||||||||||||
parameter-scope | enum(parameter-scope) | N | Y | Y | N | N | Configlet Parameter Scope It can take one of the following values
Possible Values:
|
||||||||||||||||||||||||||||||||||
parameter-type | enum(parameter-type) | N | Y | Y * | N | N | Configlet Parameter Type It can take one of the following values
Possible Values:
|
||||||||||||||||||||||||||||||||||
regex-value | String | N | Y | Y | N | N | Regex value This field contains the regular expression for the parameter which is used to validate the parameter value while applying the configlet to the device Note: This field is applicable based on the following table:
|
||||||||||||||||||||||||||||||||||
configured-value-xpath | String | N | Y | Y | N | N | Configured value xpath This field specifies the Xpath (With reference to device XML), from which the value of the parameter has to be fetched. Note: This field is applicable based on the following table:
Example : /device/interface-information/physical-interface/name/text(). |
||||||||||||||||||||||||||||||||||
default-value | String | N | Y | Y | N | N | Default value The behavior is same as that of Configured value Xpath except that the value is given explicitly. Note: This field is applicable based on the following table:
|
||||||||||||||||||||||||||||||||||
selection-values-xpath | String | N | Y | Y | N | N | Selection Values Xpath This field is enabled only for parameter type Selection Field. This field contains the Xpath (with reference to device xml) to fetch the set of values for the selection field. Note: This field is applicable based on the following table:
Example : /device/interface-information/physical-interface/name/text(). |
||||||||||||||||||||||||||||||||||
selection-values | String | N | Y | Y | N | N | Selection Values This field is same as Selection values Xpath except that the comma separated value is given explicitly. Note: This field is applicable based on the following table:
|
||||||||||||||||||||||||||||||||||
order | Integer | N | Y | Y * | N | N | Order The order in which the parameters would be listed while applying. Min: 1 Max: 65535. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | N | Y | Y | Link to this cli-configlet node in the current node context. |
cli-configlet-approval-workflow | Boolean | N | Y | Y * |
Authentication Mode. |
advanced-xpath-processing | Boolean | N | Y | Y * |
Advanced XPath Processing. |
Field Name | Type | Read Only | GET | PUT / POST | Description | ||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this cli-configlet-param node in the current node context. |
||||||||||||||||||||||||||||||||||
id | Integer | N | Y | Y * | Configlet Parameter ID Unique key for the parameter of the configlet. |
||||||||||||||||||||||||||||||||||
configlet-id | Integer | N | Y | Y * | Configlet ID The ID of the configlet for which the parameter belongs to. |
||||||||||||||||||||||||||||||||||
parameter | String | N | Y | Y * | Parameter Name The name of the parameter as used in the configlet. |
||||||||||||||||||||||||||||||||||
display-name | String | N | Y | Y * | Display Name User friendly name for the parameter. |
||||||||||||||||||||||||||||||||||
description | String | N | Y | Y * | Description Description for the parameter. |
||||||||||||||||||||||||||||||||||
parameter-scope | enum(parameter-scope) | N | Y | Y | Configlet Parameter Scope It can take one of the following values
Possible Values:
|
||||||||||||||||||||||||||||||||||
parameter-type | enum(parameter-type) | N | Y | Y * | Configlet Parameter Type It can take one of the following values
Possible Values:
|
||||||||||||||||||||||||||||||||||
regex-value | String | N | Y | Y * | Regex value This field contains the regular expression for the parameter which is used to validate the parameter value while applying the configlet to the device Note: This field is applicable based on the following table:
|
||||||||||||||||||||||||||||||||||
configured-value-xpath | String | N | Y | Y * | Configured value xpath This field specifies the Xpath (With reference to device XML), from which the value of the parameter has to be fetched. Note: This field is applicable based on the following table:
Example : /device/interface-information/physical-interface/name/text(). |
||||||||||||||||||||||||||||||||||
default-value | String | N | Y | Y * | Default value The behavior is same as that of Configured value Xpath except that the value is given explicitly. Note: This field is applicable based on the following table:
|
||||||||||||||||||||||||||||||||||
selection-values-xpath | String | N | Y | Y | Selection Values Xpath This field is enabled only for parameter type Selection Field. This field contains the Xpath (with reference to device xml) to fetch the set of values for the selection field. Note: This field is applicable based on the following table:
Example : /device/interface-information/physical-interface/name/text(). |
||||||||||||||||||||||||||||||||||
selection-values | String | N | Y | Y | Selection Values This field is same as Selection values Xpath except that the comma separated value is given explicitly. Note: This field is applicable based on the following table:
|
||||||||||||||||||||||||||||||||||
order | Integer | N | Y | Y * | Order The order in which the parameters would be listed while applying. Min: 1 Max: 65535. |
||||||||||||||||||||||||||||||||||
dependent-parameter-list | cli-configlet-param. | N | Y | Y * | List of dependent parameter details. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this dependentParameterLists node in the current node context. |
dependent-parameter | cli-configlet-param. | N | Y | Y * | Dependent parameter Dependent parameter is a parameter which is referred in some other parameters. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | N | Link to this configletParamForNBI node in the current node context. |
parameter | cli-configlet-param. | Y | Y | N | N | N | parameter Parameter which is referred by other parameters in xpath. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@href | String(URI) | N | Y | Y * | Link to an external paramForNBI. Hyperlink Template: /api/space/configuration-management/cli-configlets/{*ID}/cli-configlet-params/{*ID}. |
param-id | Integer | Y | Y | N | Configlet Parameter ID Unique ID of the parameter. Default: 0. |
name | String | Y | Y | N | Parameter Name Name of the parameter. |
configlet-id | Integer | Y | Y | N | Configlet ID Unique Id of the configlet. Default: 0. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this cli-configlet-params node in the current node context. |
@total | Integer | Y | Y | N | Total number of cli-configlet-params in the API result set. |
cli-configlet-param | cli-configlet-params. | N | Y | Y * | Configlet parameter details. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description | ||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
@href | String(URI) | Y | Y | N | N | N | Link to an external cliTemplateAdvanceConfig. Hyperlink Template: /api/space/configuration-management/cli-configlets/{*ID}/cli-configlet-params/{*ID}. |
||||||||||||||||||||||||||||||||||
id | Integer | Y | Y | N | N | N | Configlet Parameter ID Unique key for the parameter of the configlet. |
||||||||||||||||||||||||||||||||||
configlet-id | Integer | Y | Y | N | N | N | Configlet ID The ID of the configlet for which the parameter belongs to. |
||||||||||||||||||||||||||||||||||
parameter | String | N | Y | Y * | N | N | Parameter Name The name of the parameter as used in the configlet. |
||||||||||||||||||||||||||||||||||
display-name | String | N | Y | Y * | N | N | Display Name User friendly name for the parameter. |
||||||||||||||||||||||||||||||||||
description | String | N | Y | Y * | N | N | Description Description for the parameter. |
||||||||||||||||||||||||||||||||||
parameter-scope | enum(parameter-scope) | N | Y | Y | N | N | Configlet Parameter Scope It can take one of the following values
Possible Values:
|
||||||||||||||||||||||||||||||||||
parameter-type | enum(parameter-type) | N | Y | Y | N | N | Configlet Parameter Type It can take one of the following values
Possible Values:
|
||||||||||||||||||||||||||||||||||
regex-value | String | N | Y | Y * | N | N | Regex value This field contains the regular expression for the parameter which is used to validate the parameter value while applying the configlet to the device Note: This field is applicable based on the following table:
|
||||||||||||||||||||||||||||||||||
configured-value-xpath | String | N | Y | Y * | N | N | Configured value xpath This field specifies the Xpath (With reference to device XML), from which the value of the parameter has to be fetched. Note: This field is applicable based on the following table:
Example : /device/interface-information/physical-interface/name/text(). |
||||||||||||||||||||||||||||||||||
default-value | String | N | Y | Y * | N | N | Default value The behavior is same as that of Configured value Xpath except that the value is given explicitly. Note: This field is applicable based on the following table:
|
||||||||||||||||||||||||||||||||||
selection-values-xpath | String | N | Y | Y | N | N | Selection Values Xpath This field is enabled only for parameter type Selection Field. This field contains the Xpath (with reference to device xml) to fetch the set of values for the selection field. Note: This field is applicable based on the following table:
Example : /device/interface-information/physical-interface/name/text(). |
||||||||||||||||||||||||||||||||||
selection-values | String | N | Y | Y | N | N | Selection Values This field is same as Selection values Xpath except that the comma separated value is given explicitly. Note: This field is applicable based on the following table:
|
||||||||||||||||||||||||||||||||||
order | Integer | N | Y | Y * | N | N | Order The order in which the parameters would be listed while applying. Min: 1 Max: 65535. |
||||||||||||||||||||||||||||||||||
read-only | Boolean | Y | Y | N | N | N | Read Only True refers the parameter can be edited/deleted when it is under the Base configlet. Default: false. |
||||||||||||||||||||||||||||||||||
dependent-parameter-list | cli-configlet-params. | N | Y | Y | N | N | List of dependent parameter details. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this dependentParameterLists node in the current node context. |
dependent-parameter | cli-configlet-params. | N | Y | Y * | Dependent parameter Dependent parameter is a parameter which is referred in some other parameters. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | N | Link to this configletParamForNBI node in the current node context. |
parameter | cli-configlet-params. | Y | Y | N | N | N | parameter Parameter which is referred by other parameters in xpath. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@href | String(URI) | N | Y | Y * | Link to an external paramForNBI. Hyperlink Template: /api/space/configuration-management/cli-configlets/{*ID}/cli-configlet-params/{*ID}. |
param-id | Integer | Y | Y | N | Configlet Parameter ID Unique ID of the parameter. Default: 0. |
name | String | Y | Y | N | Parameter Name Name of the parameter. |
configlet-id | Integer | Y | Y | N | Configlet ID Unique Id of the configlet. Default: 0. |
Field Name | Type | Read Only | GET | PUT / POST | PATCH | Description |
---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | Link to this cli-configlets node in the current node context. |
@total | Integer | Y | Y | N | N | Total number of cli-configlets in the API result set. |
cli-configlet | cli-configlets. | N | Y | Y * | Y | Configlet details. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | N | Link to this cliConfigurationTemplate node in the current node context. Hyperlink Template: /api/space/configuration-management/cli-configlets/{*ID}. |
||||||||||
@href | String(URI) | Y | Y | N | N | N | Link to an external cliConfigurationTemplate. Hyperlink Template: /api/space/configuration-management/cli-configlets/{*ID}. |
||||||||||
id | Integer | Y | Y | N | N | N | Configlet ID This is the unique key value used to access/identify the specific configlet. |
||||||||||
name | String | N | Y | Y * | Y | Y | Configlet Name The Name cannot exceed 255 characters. You cannot have two configlets with the same name in one domain. |
||||||||||
latest-version | String | Y | Y | N | Y | Y | Latest Version Latest version of the configlet. Default: "1.0". |
||||||||||
category | String | N | Y | Y | Y | Y | Category Category for which the configlet belongs to and this is an arbitrary value, which can be used for filtering. The Category cannot exceed 255 characters. |
||||||||||
description | String | N | Y | Y | N | N | Description Description of the configlet and it cannot exceed 2500 characters. |
||||||||||
device-family | String | N | Y | Y * | Y | Y | Device Family The device family for which the configlet will be applicable for. |
||||||||||
execution-type | enum(execution-type) | N | Y | Y | Y | Y | Types of Execution There are two types of execution types.
Possible Values:
Default: SINGLE. |
||||||||||
reference-number | Integer | N | Y | Y | Y | Y | Reference Number Reference Number is an arbitrary value which can be used for filtering the configlet. Min: 1 Max: 65535. |
||||||||||
domain-id | Integer | Y | Y | N | N | N | Domain ID It specifies the domain ID for which this configlet belongs to. |
||||||||||
domain-name | String | Y | Y | N | N | N | Domain Name Name of the domain for which the configlet belongs to. |
||||||||||
creation-time | Date | Y | Y | N | Y | Y | Creation Time The time when the configlet was created. |
||||||||||
last-updated-time | Date | Y | Y | N | Y | Y | Last Modified Time The time when the configlet was updated at last. |
||||||||||
last-modified-by | String | Y | Y | N | Y | Y | Last Modified user The name of the user who modified the configlet at last. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this clone-request node in the current node context. |
cloned-device-name | String | N | Y | Y * | Name of the cloned device. |
device-count | Integer | N | Y | Y * | Number of clones to be created. |
image-upgrade-validation | Boolean | N | Y | Y * | Possible values
1. |
device-image | clone-request. | N | Y | Y |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this deviceImage node in the current node context. |
@href | String(URI) | N | Y | Y * | Link to an external deviceImage. Hyperlink Template: /api/space/software-management/packages/{*ID}. |
id | Integer | Y | Y | N | Id of the Image. |
name | String | N | Y | Y | Name of the image file(optional field). |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
template-name | String | N | Y | Y * | Template Name. |
template-desc | String | N | Y | Y * | Template Desc. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
value | Integer | N | Y | Y * | Value. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
device-ids | compare-config-by-devices-request. | N | Y | Y * | |
compare-device-config | boolean | N | Y | Y * |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this deviceIDs node in the current node context. |
device-id | Integer[] | N | Y | Y * | Device IDs. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this compute-configlet-parameter-values-request node in the current node context. |
configlet | compute-configlet-parameter-values-request. | N | Y | Y * | Configlet details
Parameter's value for this configlet would be calculated. |
compute-configlet-parameter-values | compute-configlet-parameter-values-request. | N | Y | Y | Compute parameter list List of parameters only for which parameter value would be computed. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this cliConfigurationTemplate node in the current node context. |
@href | String(URI) | N | Y | Y * | Link to an external cliConfigurationTemplate. Hyperlink Template: /api/space/configuration-management/cli-configlets/{*ID}. |
id | Integer | Y | Y | N | configlet ID
This is the unique key value used to access/identify the specific configlet. |
name | String | Y | Y | N | Name of the configlet The Name cannot exceed 255 characters. You cannot have two configlets with the same name. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this computeParameterLists node in the current node context. |
compute-configlet-parameter-value | compute-configlet-parameter-values-request. | N | Y | Y * | Compute Configlet Parameter Value Configlet parameter for which value to be computed. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | N | Link to this computeParameterValuesList node in the current node context. |
parameter | compute-configlet-parameter-values-request. | N | Y | Y * | N | N | Parameter Details of the configlet parameter. |
dependent-parameter-values | compute-configlet-parameter-values-request. | N | Y | Y | N | N | Dependent parameter list List of dependent parameters are referred by this parameter. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this paramForNBI node in the current node context. |
@href | String(URI) | N | Y | Y * | Link to an external paramForNBI. Hyperlink Template: /api/space/configuration-management/cli-configlets/{*ID}/cli-configlet-params/{*ID}. |
param-id | Integer | Y | Y | N | Configlet Parameter ID Unique ID for the configlet parameter. Default: 0. |
name | String | Y | Y | N | Parameter Name Name of the parameter. |
configlet-id | Integer | Y | Y | N | Configlet ID Unique ID for the configlet. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this dependentValues node in the current node context. |
@total | Integer | Y | Y | N | Total number of gen_compute-configlet-parameter-values-request-compute-parameter-list-compute-parameter-lists-dependent-values in the API result set. |
dependent-parameter-value | compute-configlet-parameter-values-request. | N | Y | Y * | Dependent Parameter Details Parameter is referred by this parameter. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | N | Link to this configletParamForNBI node in the current node context. |
parameter | compute-configlet-parameter-values-request. | N | Y | Y * | N | N | Parameter Details of the parameter. |
parameter-value | String | N | Y | Y * | N | N | Parameter Value Value of the dependent parameter. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this paramForNBI node in the current node context. |
@href | String(URI) | N | Y | Y * | Link to an external paramForNBI. Hyperlink Template: /api/space/configuration-management/cli-configlets/{*ID}/cli-configlet-params/{*ID}. |
parameter-id | Integer | Y | Y | N | Configlet Parameter ID Unique ID for the configlet parameter. Default: 0. |
name | String | Y | Y | N | Parameter Name Name of the parameter. |
configlet-id | Integer | Y | Y | N | Configlet ID This is the unique key value used to access/identify the specific configlet. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this compute-configlet-parameter-values-response node in the current node context. |
compute-configlet-parameter-values | compute-configlet-parameter-values-response. | N | Y | Y * | Computed Configlet parameter list. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this computedParameterValues node in the current node context. |
compute-configlet-parameter-value | compute-configlet-parameter-values-response. | N | Y | Y * | Computed configlet parameter details Parameter values based on the given dependent parameter values or xpath expression defined in the parameter definition. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | N | Link to this computeParameterValuesList node in the current node context. |
parameter | compute-configlet-parameter-values-response. | N | Y | Y * | N | N | Parameter details Parameter for which values are computed. |
parameter-value | String | N | Y | Y | N | N | Parameter Value Value of the parameter. |
possible-values | compute-configlet-parameter-values-response. | N | Y | Y | N | N | Possible Values List of possible values for the parameter. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this paramForNBI node in the current node context. |
@href | String(URI) | N | Y | Y * | Link to an external paramForNBI. Hyperlink Template: /api/space/configuration-management/cli-configlets/{*ID}/cli-configlet-params/{*ID}. |
parameter-id | Integer | Y | Y | N | Configlet Parameter ID Unique ID for the configlet parameter. Default: 0. |
name | String | Y | Y | N | Parameter Name Name of the parameter. |
configlet-id | Integer | Y | Y | N | Configlet ID Unique ID for the configlet. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this possibleValues node in the current node context. |
@total | Integer | Y | Y | N | Total number of gen_compute-configlet-parameter-values-response-computed-parameter-values-computed-parameter-values-possible-values in the API result set. |
possible-value | String[] | N | Y | Y * | Possible Values. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this compute-parameter-values-request node in the current node context. |
device | compute-parameter-values-request. | N | Y | Y * | Device details Xpath values will be evaluated against the given device configuration. |
compute-parameter-values | compute-parameter-values-request. | N | Y | Y | Compute parameter list List of parameters only for which parameter value would be computed. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@href | String(URI) | N | Y | Y * | Link to an external device. Hyperlink Template: /api/space/device-management/devices/{*ID}. |
id | Integer | Y | Y | N | Device ID Unique ID of the device. |
name | String | Y | Y | N | Device Name. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this computeParameterLists node in the current node context. |
compute-parameter-value | compute-parameter-values-request. | N | Y | Y * | Compute Parameter Value Configlet parameter for which value to be computed. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | N | Link to this computeParameterValuesList node in the current node context. |
parameter | compute-parameter-values-request. | N | Y | Y * | N | N | Parameter Details of the configlet parameter. |
dependent-parameter-values | compute-parameter-values-request. | N | Y | Y | N | N | Dependent parameter list List of dependent parameters are referred by this parameter. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@href | String(URI) | N | Y | Y * | Link to an external paramForNBI. Hyperlink Template: /api/space/configuration-management/cli-configlets/{*ID}/cli-configlet-params/{*ID}. |
param-id | Integer | Y | Y | N | Configlet Parameter ID Unique Id for the configlet parameter. Default: 0. Default: 0. |
name | String | Y | Y | N | Parameter Name Name of the parameter. |
configlet-id | Integer | Y | Y | N | Configlet ID Unique Id for the configlet. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this dependentValues node in the current node context. |
@total | Integer | Y | Y | N | Total number of gen_compute-parameter-values-request-compute-parameter-list-compute-parameter-lists-dependent-values in the API result set. |
dependent-parameter-value | compute-parameter-values-request. | N | Y | Y * | Dependent Parameter Details Parameter is referred by this parameter. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | N | Link to this configletParamForNBI node in the current node context. |
parameter | compute-parameter-values-request. | N | Y | Y | N | N | Parameter Details of the parameter. |
parameter-value | String | N | Y | Y * | N | N | Parameter Value Value of the dependent parameter. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this paramForNBI node in the current node context. |
@href | String(URI) | N | Y | Y * | Link to an external paramForNBI. Hyperlink Template: /api/space/configuration-management/cli-configlets/{*ID}/cli-configlet-params/{*ID}. |
parameter-id | Integer | Y | Y | N | Configlet Parameter ID Unique Id of the parameter. Default: 0. |
name | String | Y | Y | N | Parameter Name Name of the parameter. |
configlet-id | Integer | Y | Y | N | Configlet ID This is the unique key value used to access/identify the specific configlet. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this compute-parameter-values-response node in the current node context. |
compute-parameter-values | compute-parameter-values-response. | N | Y | Y | Computed parameter value list. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this computedParameterValues node in the current node context. |
compute-parameter-value | compute-parameter-values-response. | N | Y | Y * | Computed parameter details Parameter values based on the given dependent parameter values or xpath expression defined in the parameter definition. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | N | Link to this computeParameterValuesList node in the current node context. |
parameter | compute-parameter-values-response. | N | Y | Y * | N | N | Parameter details Parameter for which values are computed. |
parameter-value | String | N | Y | Y | N | N | Parameter Value Value of the parameter. |
possible-values | compute-parameter-values-response. | N | Y | Y | N | N | Possible Values List of possible values for the parameter. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@href | String(URI) | N | Y | Y * | Link to an external paramForNBI. Hyperlink Template: /api/space/configuration-management/cli-configlets/{*ID}/cli-configlet-params/{*ID}. |
parameter-id | Integer | Y | Y | N | Configlet Parameter ID Unique ID of the parameter. Default: 0. |
name | String | Y | Y | N | Parameter Name Name of the parameter. |
configlet-id | Integer | Y | Y | N | Configlet ID Unique ID for the configlet. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this possibleValues node in the current node context. |
@total | Integer | Y | Y | N | Total number of gen_compute-parameter-values-response-computed-parameter-values-computed-parameter-values-possible-values in the API result set. |
possible-value | String[] | N | Y | Y * | Possible Value Possible value for the parameter. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | N | Y | Y | Link to this config-file node in the current node context. |
latestVersionUpdateTime | String | N | Y | Y | Last time latest version was updated. |
deviceFamily | String | N | Y | Y | Device family for configuration file. |
fileName | String | N | Y | Y | Name of configuration file. |
latestVersion | Integer | N | Y | Y | Latest version of configuration file. |
id | int | N | Y | Y * | Configuration File ID. |
size | long | N | Y | Y * | Size (KB) of configuration file. |
deviceName | String | N | Y | Y | Name of device associated with this configuration file. |
deviceId | int | N | Y | Y * | ID of device for this configuration file. |
config-file-versions | config-file. | N | Y | Y | All versions of this configuration file. |
device | String | N | Y | Y | Device link for the device associated with this configuration file. |
latest-version | String | N | Y | Y | Latest version link pointing to the the version document for this configuration file. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | N | Y | Y | Link to this configFileVersionMOs node in the current node context. |
config-file-version | config-file. | N | Y | Y | Configuration file version information. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@href | String(URI) | N | Y | Y | N | N | Link to an external configFileVersionMO. |
@uri | String(URI) | N | Y | Y | N | N | Link to this configFileVersionMO node in the current node context. |
id | int | N | Y | Y * | N | N | Version ID. |
versionId | int | N | Y | Y * | N | N | Internal version id. |
creationTime | String | N | Y | Y | N | N | Time this version was created. |
comment | String | N | Y | Y | N | N | User specified comment for this version. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@size | Integer | N | Y | Y | Total number of configuration files available in the system. |
@uri | String(URI) | N | Y | Y | Link to this config-files node in the current node context. |
config-file | config-files. | N | Y | Y | List of configuration files. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@uri | String(URI) | N | Y | Y | N | N | Link to this configFileMO node in the current node context. |
@href | String(URI) | N | Y | Y | N | N | Link to an external configFileMO. |
latestVersionUpdateTime | String | N | Y | Y | N | N | Last update time for latest version. |
deviceFamily | String | N | Y | Y | Y | Y | Device Family. |
configFileName | String | N | Y | Y | Y | Y | Name of configuration file. |
latestVersion | Integer | N | Y | Y | Y | Y | Latest version document for this configuration file. |
id | int | N | Y | Y | Y | Y | Configuration File ID. |
deviceName | String | N | Y | Y | Y | Y | Device Name associated with this configuration file. |
deviceId | int | N | Y | Y | Y | Y | Device ID. |
device | String | N | Y | Y | N | N | Device associated with this configuration file. |
latest-version | String | N | Y | Y | N | N | Latest version for this configuration file. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | N | Y | Y | Link to this config-file-version node in the current node context. |
id | int | N | Y | Y * | Version href ID. |
fileName | String | N | Y | Y | File name. |
configFileSize | long | N | Y | Y * | File size for this version. |
content | String | N | Y | Y | Config XML for this version. |
versionId | int | N | Y | Y * | Version ID. |
creationTime | String | N | Y | Y | Time version was created. |
comment | String | N | Y | Y | User provided comment. |
latestMD5 | String | N | Y | Y | MD5 for this version. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@size | Integer | N | Y | Y | Total number of versions available in the system. |
@uri | String(URI) | N | Y | Y | Link to this config-file-versions node in the current node context. |
config-file-version | config-file-versions. | N | Y | Y | A single version document. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@uri | String(URI) | N | Y | Y | N | N | Link to this configFileVersionMO node in the current node context. |
@href | String(URI) | N | Y | Y | N | N | Link to an external configFileVersionMO. |
id | int | N | Y | Y * | N | N | Href ID for this version. |
versionId | int | N | Y | Y * | N | N | Version ID. |
creationTime | String | N | Y | Y | N | N | Time version was created. |
comment | String | N | Y | Y | N | N | User provided comment. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this configlet node in the current node context. |
xml-configlet-data | String | N | Y | Y * | Configlet in XML format. |
curly-braces-configlet-data | String | N | Y | Y * | Configlet in Curly braces format. |
cli-configlet-data | String | N | Y | Y * | Configlet in CLI format(set commands). |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this configlets node in the current node context. |
@total | Integer | Y | Y | N | Total number of configlets in the API result set. |
configlet | configlets. | N | Y | Y * | Configlet which contains modeled-device configuration in CLI/CURLY BRACES/XML format. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@href | String(URI) | N | Y | Y * | N | N | Link to an external deployDeviceConfiglet. Hyperlink Template: /api/space/device-management/devices/{*ID}/configlet. |
@uri | String(URI) | Y | Y | N | N | N | Link to this deployDeviceConfiglet node in the current node context. Hyperlink Template: /api/space/device-management/modeled-device-management/modeled-instances/{*ID}/configlets. |
device-id | Integer | Y | Y | N | N | N | Id of device. |
Field Name | Type | Read Only | GET | PUT / POST | PATCH | Description | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
@uri | String(URI) | N | Y | Y | N | Link to this config-template node in the current node context. Hyperlink Template: /api/space/config-template-management/config-templates/{*ID}. |
||||||||||||||||||||
@href | String(URI) | Y | Y | N | N | Link to an external config-template. Hyperlink Template: /api/space/config-template-management/config-templates/{*ID}. |
||||||||||||||||||||
*id | Integer | Y | Y | N | N | The ID of the configuration template. |
||||||||||||||||||||
name | String | N | Y | Y * | Y | The name of the configuration template. |
||||||||||||||||||||
description | String | N | Y | Y * | Y | A description of the configuration template. |
||||||||||||||||||||
config-type | enum(config-type) | Y | Y | N | N | The configuration type for the configuration template. Possible Values:
|
||||||||||||||||||||
state | String | Y | Y | N | N | The state of the configuration template. |
||||||||||||||||||||
os-version | String | Y | Y | N | N | The Junos OS version for the configuration template. |
||||||||||||||||||||
current-version | Integer | Y | Y | N | N | The current version of the configuration template. |
||||||||||||||||||||
device-family | String | Y | Y | N | N | The Junos Device family for the configuration template. |
||||||||||||||||||||
last-updated-by | String | Y | Y | N | N | The user who last updated this configuration template. |
||||||||||||||||||||
last-update-time-string | String | Y | Y | N | N | The date and time that the configuration template was last modified. |
||||||||||||||||||||
template-deployment-status | String | Y | Y | N | N | The status of the configuration template's deployment. |
||||||||||||||||||||
config-template-definition | config-template. | N | Y | Y * | Y | A configuration template definition is an object that defines a partial configuration or a set of
configuration nodes from which a template can be built. |
||||||||||||||||||||
domain-name | String | N | Y | Y | Y | The name of the domain to which the template belongs. |
||||||||||||||||||||
domain-id | Integer | N | Y | Y | Y | The ID of the domain to which the template belongs. |
||||||||||||||||||||
domain | String | Y | Y | N | N | The domain to which the template belongs. Hyperlink Template: /api/space/domain-management/domains/{*ID}. |
||||||||||||||||||||
configuration | String | Y | Y | N | N | The XML configuration for this template Hyperlink Template: /api/space/config-template-management/config-templates/{*ID}/configuration. |
||||||||||||||||||||
exec-deploy | String | Y | Y | N | N | Deploy template configuration on a single device or a group of devices Hyperlink Template: /api/space/config-template-management/config-templates/{*ID}/exec-deploy. |
||||||||||||||||||||
exec-undeploy | String | Y | Y | N | N | Undeploy template configuration from a single device or a group of devices Hyperlink Template: /api/space/config-template-management/config-templates/{*ID}/exec-undeploy. |
||||||||||||||||||||
exec-audit | String | Y | Y | N | N | Audit template configuration against all the devices on which this template has been previously
deployed. Hyperlink Template: /api/space/config-template-management/config-templates/{*ID}/exec-audit. |
||||||||||||||||||||
device-associations | String | Y | Y | N | N | Device associations for this template Hyperlink Template: /api/space/config-template-management/config-templates/{*ID}/device-associations. |
||||||||||||||||||||
exec-publish | String | Y | Y | N | N | Publish template to device configuration Hyperlink Template: /api/space/config-template-management/config-templates/{*ID}/exec-publish. |
||||||||||||||||||||
versions | String | Y | Y | N | N | See all versions of the template. Hyperlink Template: /api/space/config-template-management/config-templates/{*ID}/versions. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@href | String(URI) | N | Y | Y * | Link to an external configTemplateDefInfo. Hyperlink Template: /api/space/config-template-management/config-template-definitions/{*ID}. |
@uri | String(URI) | Y | Y | N | Link to this configTemplateDefInfo node in the current node context. Hyperlink Template: /api/space/config-template-management/config-templates/{*ID}. |
id | Integer | Y | Y | N | The ID for the configuration template definition. |
name | String | Y | Y | N | The name of the configuration template definition. |
configuration | String | Y | Y | N | The XML configuration for this template definition Hyperlink Template: /api/space/config-template-management/config-template-definitions/{*ID}/configuration. |
Field Name | Type | Read Only | GET | PUT / POST | Description | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
@uri | String(URI) | N | Y | Y | Link to this config-template node in the current node context. Hyperlink Template: /api/space/config-template-management/config-templates/{*ID}. |
||||||||||||||||||||
@href | String(URI) | Y | Y | N | Link to an external config-template. Hyperlink Template: /api/space/config-template-management/config-templates/{*ID}. |
||||||||||||||||||||
*id | Integer | Y | Y | N | ConfigTemplateInfo ID. |
||||||||||||||||||||
name | String | N | Y | Y * | ConfigTemplateInfo Name. |
||||||||||||||||||||
description | String | N | Y | Y * | Description. |
||||||||||||||||||||
deployed-tempalte-ver | Integer | N | Y | Y * | Deployed Tempalte Ver. |
||||||||||||||||||||
versions | config-template. | Y | Y | N | |||||||||||||||||||||
config-type | enum(config-type) | Y | Y | N | Config Type. Possible Values:
|
||||||||||||||||||||
state | String | Y | Y | N | State. |
||||||||||||||||||||
os-version | String | Y | Y | N | Os Version. |
||||||||||||||||||||
current-version | Integer | Y | Y | N | Current Version. |
||||||||||||||||||||
device-family | String | Y | Y | N | Device Family. |
||||||||||||||||||||
last-updated-by | String | Y | Y | N | Last Updated By. |
||||||||||||||||||||
last-update-time-string | String | Y | Y | N | Last Update Time String. |
||||||||||||||||||||
template-deployment-status | String | Y | Y | N | Template Deployment Status. |
||||||||||||||||||||
config-template-definition | config-template. | N | Y | Y | Template Version details with possible operations. |
||||||||||||||||||||
domain-name | String | N | Y | Y | Domain Name. |
||||||||||||||||||||
domain-id | Integer | N | Y | Y | Domain ID. |
||||||||||||||||||||
domain | String | Y | Y | N | The domain to which the template belongs. Hyperlink Template: /api/space/domain-management/domains/{*ID}. |
||||||||||||||||||||
configuration | String | Y | Y | N | The XML configuration for this template Hyperlink Template: /api/space/config-template-management/config-templates/{*ID}/configuration. |
||||||||||||||||||||
exec-deploy | String | Y | Y | N | Deploy template configuration on a single device or a group of devices Hyperlink Template: /api/space/config-template-management/config-templates/{*ID}/exec-deploy. |
||||||||||||||||||||
exec-undeploy | String | Y | Y | N | Undeploy template configuration from a single device or a group of devices Hyperlink Template: /api/space/config-template-management/config-templates/{*ID}/exec-undeploy. |
||||||||||||||||||||
exec-audit | String | Y | Y | N | Audit template configuration against all the devices on which this template has been previously
deployed. Hyperlink Template: /api/space/config-template-management/config-templates/{*ID}/exec-audit. |
||||||||||||||||||||
device-associations | String | Y | Y | N | Device associations for this template Hyperlink Template: /api/space/config-template-management/config-templates/{*ID}/device-associations. |
||||||||||||||||||||
exec-publish | String | Y | Y | N | Publish template to device configuration Hyperlink Template: /api/space/config-template-management/config-templates/{*ID}/exec-publish. |
||||||||||||||||||||
versions | String | Y | Y | N | See all versions of the template. Hyperlink Template: /api/space/config-template-management/config-templates/{*ID}/versions. |
||||||||||||||||||||
clone | String | Y | Y | N | Clone template from Id Hyperlink Template: /api/space/config-template-management/config-templates/{*ID}/clone. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this versions node in the current node context. |
@total | Integer | Y | Y | N | Total number of gen_config-template-versions in the API result set. |
version | Integer[] | N | Y | Y * | Versions. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@href | String(URI) | N | Y | Y * | Link to an external configTemplateDefInfo. Hyperlink Template: /api/space/config-template-management/config-template-definitions/{*ID}. |
@uri | String(URI) | Y | Y | N | Link to this configTemplateDefInfo node in the current node context. Hyperlink Template: /api/space/config-template-management/config-templates/{*ID}. |
id | Integer | Y | Y | N | ConfigTemplateDefInfo ID. |
name | String | Y | Y | N | ConfigTemplateDefInfo Name. |
configuration | String | Y | Y | N | The XML configuration for this template definition Hyperlink Template: /api/space/config-template-management/config-template-definitions/{*ID}/configuration. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | N | Y | Y | Link to this config-template-definition node in the current node context. Hyperlink Template: /api/space/config-template-management/config-template-definitions/{*ID}. |
@href | String(URI) | Y | Y | N | Link to an external config-template-definition. Hyperlink Template: /api/space/config-template-management/config-template-definitions/{*ID}. |
*id | Integer | Y | Y | N | The ID for the configuration template definition. |
name | String | Y | Y | N | The name of the configuration template definition. |
description | String | Y | Y | N | A description for this configuration template definition. |
versions | config-template-definition. | N | Y | Y * | The device versions to which the template can be deployed. |
state | String | Y | Y | N | The state of this configuration template definition. |
published | Boolean | Y | Y | N | A flag that indicates whether this configuration template definition was published. |
os-version | String | Y | Y | N | The Junos OS version for this configuration template definition. |
current-version | Integer | Y | Y | N | The current version of this configuration template definition. |
device-family | String | Y | Y | N | The Junos device family for this configuration template definition. |
last-updated-by | String | Y | Y | N | The user who last updated this configuration template definition. |
last-update-time | String | Y | Y | N | The date and time when this configuration template definition was last modified. |
config-templates | config-template-definition. | Y | Y | N | A list of configuration templates for this configuration template definition. |
domain-name | String | N | Y | Y * | The name of the domain to which the template belongs. |
domain-id | Integer | N | Y | Y * | The ID of the domain to which the template belongs. |
domain | String | Y | Y | N | The domain to which the template belongs. Hyperlink Template: /api/space/domain-management/domains/{*ID}. |
configuration | String | Y | Y | N | The XML configuration for this template definition Hyperlink Template: /api/space/config-template-management/config-template-definitions/{*ID}/configuration. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this versions node in the current node context. |
version | Integer[] | N | Y | Y * | The device version. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | N | Y | Y | Link to this configTemplates node in the current node context. Hyperlink Template: /api/space/config-template-management/config-template-definitions/{*ID}/config-templates. |
config-template | config-template-definition. | N | Y | Y * | A configuration template represents a partial configuration that can be deployed or published to
a single device or group of devices. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@href | String(URI) | N | Y | Y * | N | N | Link to an external configTemplateInfo. Hyperlink Template: /api/space/config-template-management/config-templates/{*ID}. |
@uri | String(URI) | Y | Y | N | N | N | Link to this configTemplateInfo node in the current node context. Hyperlink Template: /api/space/config-template-management/config-template-definitions/{*ID}/config-templates/{*ID}. |
id | Integer | Y | Y | N | N | N | The ID of the configuration template. |
name | String | Y | Y | N | N | N | The name of the configuration template. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | N | Y | Y | Link to this config-template-definitions node in the current node context. |
@total | Integer | Y | Y | N | Total number of config-template-definitions in the API result set. |
config-template-definition | config-template-definitions. | N | Y | Y * | A configuration template definition is an object that defines a partial configuration or a set of
configuration nodes from which a template can be built. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@uri | String(URI) | N | Y | Y | N | N | Link to this configTemplateDefInfo node in the current node context. Hyperlink Template: /api/space/config-template-management/config-template-definitions/{*ID}. |
@href | String(URI) | Y | Y | N | N | N | Link to an external configTemplateDefInfo. Hyperlink Template: /api/space/config-template-management/config-template-definitions/{*ID}. |
id | Integer | Y | Y | N | Y | Y | The ID for the configuration template definition. |
name | String | Y | Y | N | Y | Y | The name of the configuration template definition. |
description | String | Y | Y | N | Y | Y | A description for this configuration template definition. |
state | String | Y | Y | N | N | N | The state of this configuration template definition. |
published | Boolean | Y | Y | N | N | N | A flag that indicates whether this configuration template definition was published. |
current-version | Integer | Y | Y | N | N | N | The current version of this configuration template definition. |
device-family | String | Y | Y | N | N | N | The Junos device family for this configuration template definition. |
last-updated-by | String | Y | Y | N | Y | Y | The user who last updated this configuration template definition. |
last-update-time | String | Y | Y | N | Y | Y | The date and time when this configuration template definition was last modified. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this config-template-details node in the current node context. Hyperlink Template: /api/space/config-template-management/config-templates/{*ID}/versions/{*ID}. |
@href | String(URI) | Y | Y | N | Link to an external config-template. Hyperlink Template: /api/space/config-template-management/config-templates/{*ID}/versions/{*ID}. |
*id | Integer | Y | Y | N | ConfigTemplateInfo ID. |
name | String | N | Y | Y * | ConfigTemplateInfo Name. |
description | String | N | Y | Y * | Description. |
domain-id | Integer | N | Y | Y | Domain ID. |
domain-name | String | N | Y | Y | Domain Name. |
versions | config-template-details. | Y | Y | N | |
deployed-tempalte-ver | Integer | N | Y | Y * | Deployed Tempalte Ver. |
state | String | Y | Y | N | State. |
config-template-definition | config-template-details. | N | Y | Y | Template Version details with possible operations. |
last-update-time | Long | Y | Y | N | Last Update Time. |
last-updated-by | String | Y | Y | N | Last Updated By. |
last-update-time-string | String | Y | Y | N | Last Update Time String. |
template-deployment-status | String | Y | Y | N | Template Deployment Status. |
current-version | Integer | Y | Y | N | Current Version. |
schema-id | String | Y | Y | N | Schema ID. |
device-family | String | Y | Y | N | Device Family. |
os-version | String | Y | Y | N | Os Version. |
configuration | String | Y | Y | N | The XML configuration for this template version Hyperlink Template: /api/space/config-template-management/config-templates/{*ID}/versions/{*ID}/configuration. |
exec-deploy | String | Y | Y | N | Deploy template configuration on a single device or a group of devices Hyperlink Template: /api/space/config-template-management/config-templates/{*ID}/versions/{*ID}/exec-deploy. |
device-associations | String | Y | Y | N | Device associations for this template version Hyperlink Template: /api/space/config-template-management/config-templates/{*ID}/versions/{*ID}/device-associations. |
exec-publish | String | Y | Y | N | Publish template version to device configuration Hyperlink Template: /api/space/config-template-management/config-templates/{*ID}/versions/{*ID}/exec-publish. |
exec-auditTemplate | String | Y | Y | N | Audit template version Hyperlink Template: /api/space/config-template-management/config-templates/{*ID}/versions/{*ID}/exec-auditTemplate. |
exec-compareConfig | String | Y | Y | N | compare config Hyperlink Template: /api/space/config-template-management/config-templates/{*ID}/versions/{*ID}/exec-compareConfig. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this versions node in the current node context. |
@total | Integer | Y | Y | N | Total number of gen_config-template-details-versions in the API result set. |
version | Integer[] | N | Y | Y * | Versions. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this configTemplateDefInfo node in the current node context. Hyperlink Template: /api/space/config-template-management/config-templates/{*ID}/versions/{*ID}. |
@href | String(URI) | N | Y | Y * | Link to an external configTemplateDefInfo. Hyperlink Template: /api/space/config-template-management/config-template-definitions/{*ID}. |
id | Integer | Y | Y | N | ConfigTemplateDefInfo ID. |
name | String | Y | Y | N | ConfigTemplateDefInfo Name. |
Field Name | Type | Read Only | GET | PUT / POST | Description | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this config-template-no-definition node in the current node context. Hyperlink Template: /api/space/config-template-management/config-templates/{*ID}. |
||||||||||||||||||||
@href | String(URI) | Y | Y | N | Link to an external config-template-no-definition. Hyperlink Template: /api/space/config-template-management/config-templates/{*ID}. |
||||||||||||||||||||
last-update-time | Long | Y | Y | N | The date and time that the configuration template was last modified. |
||||||||||||||||||||
domain-id | Integer | N | Y | Y | The ID of the domain to which the template belongs. |
||||||||||||||||||||
description | String | N | Y | Y * | A description of the configuration template. |
||||||||||||||||||||
last-update-time-string | String | Y | Y | N | The date and time that the configuration template was last modified. |
||||||||||||||||||||
id | Integer | Y | Y | N | The ID of the configuration template. |
||||||||||||||||||||
state | String | Y | Y | N | The state of the configuration template. |
||||||||||||||||||||
name | String | N | Y | Y * | The name of the configuration template. |
||||||||||||||||||||
current-version | Integer | Y | Y | N | The current version of the configuration template. |
||||||||||||||||||||
last-updated-by | String | Y | Y | N | The user who last updated this configuration template. |
||||||||||||||||||||
domain-name | String | N | Y | Y | The name of the domain to which the template belongs. |
||||||||||||||||||||
device-family | String | N | Y | Y * | The Junos Device family for the configuration template. |
||||||||||||||||||||
os-version | String | N | Y | Y | The Junos OS version for the configuration template. |
||||||||||||||||||||
config-type | enum(config-type) | Y | Y | N | The configuration type for the configuration template. Possible Values:
|
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this config-template-ref node in the current node context. Hyperlink Template: /api/space/config-template-management/config-template-definitions/{*ID}/config-templates/{*ID}. |
@href | String(URI) | N | Y | Y * | Link to an external config-template-ref. Hyperlink Template: /api/space/config-template-management/config-templates/{*ID}. |
domain-id | Integer | Y | Y | N | The ID of the domain to which the template belongs. |
*id | Integer | Y | Y | N | The ID of the configuration template. |
name | String | Y | Y | N | The name of the configuration template. |
domain-name | String | Y | Y | N | The name of the domain to which the template belongs. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | N | Y | Y | Link to this config-template-refs node in the current node context. Hyperlink Template: /api/space/config-template-management/config-template-definitions/{*ID}/config -templates. |
@total | Integer | Y | Y | N | Total number of config-templates in the API result set. |
config-template | config-template-refs. | N | Y | Y * | A configuration template represents a partial configuration that can be deployed or published to
a single device or group of devices. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@href | String(URI) | N | Y | Y * | N | N | Link to an external configTemplateInfo. Hyperlink Template: /api/space/config-template-management/config-templates/{*ID}. |
@uri | String(URI) | Y | Y | N | N | N | Link to this configTemplateInfo node in the current node context. Hyperlink Template: /api/space/config-template-management/config-template-definitions/{*ID}/config-templates/{*ID}. |
id | Integer | Y | Y | N | N | N | The ID of the configuration template. |
name | String | Y | Y | N | N | N | The name of the configuration template. |
Field Name | Type | Read Only | GET | PUT / POST | PATCH | Description |
---|---|---|---|---|---|---|
@uri | String(URI) | N | Y | Y | N | Link to this config-templates node in the current node context. |
@total | Integer | Y | Y | N | N | Total number of config-templates in the API result set. |
config-template | config-templates. | N | Y | Y * | Y | A configuration template represents a partial configuration that can be deployed or published to
a single device or group of devices. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
@uri | String(URI) | N | Y | Y | N | N | Link to this configTemplateInfo node in the current node context. Hyperlink Template: /api/space/config-template-management/config-templates/{*ID}. |
||||||||||||||||||||
@href | String(URI) | Y | Y | N | N | N | Link to an external configTemplateInfo. Hyperlink Template: /api/space/config-template-management/config-templates/{*ID}. |
||||||||||||||||||||
id | Integer | Y | Y | N | Y | Y | The ID of the configuration template. |
||||||||||||||||||||
name | String | N | Y | Y * | Y | Y | The name of the configuration template. |
||||||||||||||||||||
description | String | N | Y | Y * | Y | Y | A description of the configuration template. |
||||||||||||||||||||
config-type | enum(config-type) | Y | Y | N | Y | Y | The configuration type for the configuration template. Possible Values:
|
||||||||||||||||||||
state | String | Y | Y | N | N | N | The state of the configuration template. |
||||||||||||||||||||
os-version | String | Y | Y | N | Y | N | The Junos OS version for the configuration template. |
||||||||||||||||||||
current-version | Integer | Y | Y | N | N | N | The current version of the configuration template. |
||||||||||||||||||||
device-family | String | Y | Y | N | Y | N | The Junos Device family for the configuration template. |
||||||||||||||||||||
last-updated-by | String | Y | Y | N | Y | Y | The user who last updated this configuration template. |
||||||||||||||||||||
last-update-time-string | String | Y | Y | N | Y | Y | The date and time that the configuration template was last modified. |
||||||||||||||||||||
domain-name | String | N | Y | Y | N | N | The name of the domain to which the template belongs. |
||||||||||||||||||||
domain-id | Integer | N | Y | Y | N | N | The ID of the domain to which the template belongs. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
template-id-list | config-templates-by-id2-request. | N | Y | Y * |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this templateIdLists node in the current node context. |
template-id-list | Integer[] | N | Y | Y * | Template ID Lists. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this config-templates-by-ids2 node in the current node context. |
@total | Integer | Y | Y | N | Total number of config-templates-by-ids2 in the API result set. |
version | config-templates-by-ids2. | N | Y | Y * |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | N | Link to this version node in the current node context. |
content | String | N | Y | Y * | N | N | Content. |
deploy-status | String | N | Y | Y * | N | N | Deploy Status. |
template-id | String | Y | Y | N | N | N | Template ID. |
modified-time | Date | N | Y | Y * | N | N | Modified Time. |
number | String | N | Y | Y * | N | N | Number. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this config-template-versions node in the current node context. |
@total | Integer | Y | Y | N | Total number of config-template-versions in the API result set. |
config-template | config-template-versions. | N | Y | Y * | Template Version details with possible operations. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | N | Link to this configTemplateInfo node in the current node context. Hyperlink Template: /api/space/config-template-management/config-templates/{*ID}/versions/{*ID}. |
||||||||||||||||||||
@href | String(URI) | Y | Y | N | N | N | Link to an external config-template. Hyperlink Template: /api/space/config-template-management/config-templates/{*ID}/versions/{*ID}. |
||||||||||||||||||||
description | String | N | Y | Y * | Y | Y | Description. |
||||||||||||||||||||
last-update-time-string | String | Y | Y | N | Y | Y | Last Update Time String. |
||||||||||||||||||||
template-deployment-status | String | Y | Y | N | N | N | Template Deployment Status. |
||||||||||||||||||||
last-update-time | Long | Y | Y | N | N | N | Last Update Time. |
||||||||||||||||||||
id | Integer | Y | Y | N | Y | Y | ConfigTemplateInfo ID. |
||||||||||||||||||||
name | String | N | Y | Y * | Y | Y | ConfigTemplateInfo Name. |
||||||||||||||||||||
current-version | Integer | Y | Y | N | Y | Y | Current Version. |
||||||||||||||||||||
device-family | String | Y | Y | N | N | N | Device Family. |
||||||||||||||||||||
os-version | String | Y | Y | N | Y | N | Os Version. |
||||||||||||||||||||
config-type | enum(config-type) | Y | Y | N | Y | Y | Config Type. Possible Values:
|
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | N | Y | Y | Link to this configuration node in the current node context. Hyperlink Template: /api/space/config-template-management/config-templates/{*ID}/configuration. |
@href | String(URI) | Y | Y | N | Link to an external configuration. Hyperlink Template: /api/space/config-template-management/config-templates/{*ID}/configuration. |
data | String | N | Y | Y * | The XML configuration document. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this configuration-all node in the current node context. Hyperlink Template: /api/space/config-template-management/templates/{*ID}/quick-template- config. |
cli | String | N | Y | Y * | The content of the configuration template in CLI format. |
xml | String | N | Y | Y * | The content of the configuration template in XML format. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this configuration-cli node in the current node context. Hyperlink Template: /api/space/config-template-management/templates/{*ID}/quick-template- config. |
cli | String | N | Y | Y * | The content of the configuration template in CLI format. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
clis | String | N | Y | Y * | Clis. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@href | String(URI) | N | Y | Y | Link to an external configurations. |
id | Integer | N | Y | Y |
A unique ID for the 'configurations' resource. |
expanded-configuration | String | N | Y | Y |
Location of the 'expanded-configuration' resource. |
raw-configuration | String | N | Y | Y |
Location of the 'raw-configuration' resource. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this configuration-update-result node in the current node context. |
err-message | String | N | Y | Y | A description of the error. |
errors | configuration-update-result. | N | Y | Y | A list of any errors in the content of the configuration template. |
status | String | N | Y | Y * | The status of the update. |
variable-existing | Boolean | N | Y | Y * | Indicates whether the template contains a variable. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this errors node in the current node context. |
validation-error | configuration-update-result. | N | Y | Y * | A list of validation errors. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | N | Link to this quickTemplateValidationError node in the current node context. |
err-reason | String | N | Y | Y * | N | N | The reason the CLI failed validation. |
line-number | Integer | N | Y | Y * | N | N | The line number in content of the configuration template where the error occurred. |
Field Name | Type | Read Only | GET | PUT / POST | PATCH | Description | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | Link to this configuration-view node in the current node context. Hyperlink Template: /api/space/configuration-management/configuration-views/{*ID}. |
||||||||||||||||||
@href | String(URI) | Y | Y | N | N | Link to an external configuration-view. Hyperlink Template: /api/space/configuration-management/configuration-views/{*ID}. |
||||||||||||||||||
*id | Integer | Y | Y | N | N | Configuration View ID Unique key for the configuration view. |
||||||||||||||||||
name | String | N | Y | Y * | Y | Configuration View Name The Name of the configuration view and it cannot exceed 255 characters. You cannot have two configuration views with the same name. |
||||||||||||||||||
domain-id | Integer | Y | Y | N | N | Domain ID It specifies the domain ID for which this configlet belongs to. |
||||||||||||||||||
domain-name | String | Y | Y | N | N | Domain Name Name of the domain for which the configlet belongs to. |
||||||||||||||||||
view-type | enum(view-type) | N | Y | Y | Y | View Type There are four types of view types
Possible Values:
Default: FORMVIEW. |
||||||||||||||||||
title | String | N | Y | Y * | Y | Title The title of the configuration view and it cannot exceed 255 characters. |
||||||||||||||||||
device-family | String | N | Y | Y * | Y | Device Family The device family for which the configuration view will be applicable for. |
||||||||||||||||||
context | String | N | Y | Y | Y | Context The context for which the configuration view would be applicable for. i. |
||||||||||||||||||
description | String | N | Y | Y | Y | Description The description of the configuration view and it cannot exceed 2500 characters. |
||||||||||||||||||
order | Integer | N | Y | Y * | Y | Order Order of the configuration view tab in Device Configuration View UI. Min: 1 Max: 65535. |
||||||||||||||||||
creation-time | Date | Y | Y | N | N | Creation Time The time when the configuration view was created. Note : to filter the configuration view based on time should be given in millisecs. |
||||||||||||||||||
last-updated-time | Date | Y | Y | N | N | Last Updated Time The time when the configuration view was updated at last Note : to filter the configuration view based on time should be given in millisecs. |
||||||||||||||||||
last-modified-by | String | Y | Y | N | N | Last Modified user The name of the user who modified the configuration view at last. |
||||||||||||||||||
configuration-view-params | configuration-view. | N | Y | Y * | Y | List of configuration view parameters. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this configViewerParams node in the current node context. Hyperlink Template: /api/space/configuration-management/configuration-views/{*ID}/configuration-view-params. |
configuration-view-param | configuration-view. | N | Y | Y * | Configuration view parameter Parameters are the variables defined in the configuration view whose values are got from the environment. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | N | Link to this configViewerParam node in the current node context. |
id | Integer | Y | Y | N | N | N | Configuration View Parameter ID Unique ID for the configuration view parameter. |
parameter | String | N | Y | Y * | N | N | Parameter Name The name of the parameter as used in the configuration view and it should start with letters and cannot exceed 255 characters and can only contain letters, numbers and characters inside this parenthesis(_-). |
index-parameter | Boolean | N | Y | Y | N | N | Index Parameter It is used to consider a parameter as an index parameter or not. This is applicable for a GRIDVIEW only. An index parameter should meet at least one of the following two conditions except when only one parameter is defined in a grid view. An index parameter should refer at least one of the other index parameters. An index parameter should be referred in one of the other parameters. A non index parameter should always refer at least one index parameter. Setting this option as true will disable Script Dependent and Customized Attribute fields Default = false. |
display-name | String | N | Y | Y * | N | N | Display name User friendly name of the configuration view parameter and it should start with letters/numbers/_ and cannot exceed 255 characters and can only contain letters, numbers and characters inside this parenthesis(_-. |
script-dependent | Boolean | N | Y | Y | N | N | Script Dependent Setting this option to true enables to refer a local script. Setting this option as true will disable Index Parameter and Customized Attribute fields Default = false. |
local-script-name | String | N | Y | Y | N | N | Local Script Name Name of the Local Script which should be available in space and if configuration view is dependent on any local script, then its name will be mentioned here otherwise this is not applicable. |
customized | Boolean | N | Y | Y | N | N | Customized Attribute It is used to associate additional data to devices, device interface and device inventory. Setting this option as true will disable Index Parameter and Script Dependent fields Default = false. |
editable | Boolean | N | Y | Y | N | N | Editable Setting this option to true enables user to edit the customized attribute and this field is not applicable if customized attribute is not set Default = false. |
configured-value-xpath | String | N | Y | Y * | N | N | Configured Value Xpath This field is used to give the Xpath of the configured values. When the view type is FORMVIEW, the corresponding value present in the Xpath is taken as the field value. When the view type is GRIDVIEW, the following behavior is followed. If more than one parameters defined then following rules should be met. For independent index parameters, the values returned by the Xpath and the existing set of rows would be combined. For dependent index parameters, the values returned by the Xpath and the correspondent row would be combined For non index parameters, if list of values returned then they are aggregated into comma separated values. |
order | Integer | N | Y | Y * | N | N | Order The order of the parameter. Min: 1 Max: 65535. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this configuration-view-param node in the current node context. |
id | Integer | N | Y | Y * | Configuration View Parameter ID Unique ID for the configuration view parameter. |
parameter | String | N | Y | Y * | Parameter Name The name of the parameter as used in the configuration view and it should start with letters and cannot exceed 255 characters and can only contain letters, numbers and characters inside this parenthesis(_-). |
index-parameter | Boolean | N | Y | Y * | Index Parameter It is used to consider a parameter as an index parameter or not. This is applicable for a GRIDVIEW only. An index parameter should meet at least one of the following two conditions except when only one parameter is defined in a grid view. An index parameter should refer at least one of the other index parameters. An index parameter should be referred in one of the other parameters. A non index parameter should always refer at least one index parameter. Setting this option as true will disable Script Dependent and Customized Attribute fields Default = false. |
display-name | String | N | Y | Y * | Display name User friendly name of the configuration view parameter and it should start with letters/numbers/_ and cannot exceed 255 characters and can only contain letters, numbers and characters inside this parenthesis(_-. |
script-dependent | Boolean | N | Y | Y * | Script Dependent Setting this option to true enables to refer a local script. Setting this option as true will disable Index Parameter and Customized Attribute fields Default = false. |
local-script-name | String | N | Y | Y * | Local Script Name Name of the Local Script which should be available in space and if configuration view is dependent on any local script, then its name will be mentioned here otherwise this is not applicable. |
customized | Boolean | N | Y | Y * | Customized Attribute It is used to associate additional data to devices, device interface and device inventory. Setting this option as true will disable Index Parameter and Script Dependent fields Default = false. |
editable | Boolean | N | Y | Y * | Editable Setting this option to true enables user to edit the customized attribute and this field is not applicable if customized attribute is not set Default = false. |
configured-value-xpath | String | N | Y | Y * | Configured Value Xpath This field is used to give the Xpath of the configured values. When the view type is FORMVIEW, the corresponding value present in the Xpath is taken as the field value. When the view type is GRIDVIEW, the following behavior is followed. If more than one parameters defined then following rules should be met. For independent index parameters, the values returned by the Xpath and the existing set of rows would be combined. For dependent index parameters, the values returned by the Xpath and the correspondent row would be combined. For non index parameters, if list of values returned then they are aggregated into comma separated values. |
order | Integer | N | Y | Y * | Order The order of the parameter. Min: 1 Max: 65535. |
Field Name | Type | Read Only | GET | PUT / POST | PATCH | Description |
---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | Link to this configuration-views node in the current node context. |
@total | Integer | Y | Y | N | N | Total number of configuration-views in the API result set. |
configuration-view | configuration-views. | N | Y | Y * | Y | Configuration view details Configuration Views are configuration tools that enables the user who wants to see configuration details in his/her own way. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | N | Link to this configViewer node in the current node context. Hyperlink Template: /api/space/configuration-management/configuration-views/{*ID}. |
||||||||||||||||||
@href | String(URI) | Y | Y | N | N | N | Link to an external configViewer. Hyperlink Template: /api/space/configuration-management/configuration-views/{*ID}. |
||||||||||||||||||
id | Integer | Y | Y | N | N | N | Configuration View ID Unique key for the configuration view. |
||||||||||||||||||
name | String | N | Y | Y * | Y | Y | Configuration View Name The Name of the configuration view and it cannot exceed 255 characters. You cannot have two configuration views with the same name. |
||||||||||||||||||
domain-id | Integer | Y | Y | N | N | Y | Domain ID It specifies the domain ID for which this configlet belongs to. |
||||||||||||||||||
domain-name | String | Y | Y | N | N | N | Domain Name Name of the domain for which the configlet belongs to. |
||||||||||||||||||
title | String | N | Y | Y * | Y | Y | Title The title of the configuration view and it cannot exceed 255 characters. |
||||||||||||||||||
device-family | String | N | Y | Y * | Y | Y | Device Family The device family for which the configuration view will be applicable for. |
||||||||||||||||||
description | String | N | Y | Y | N | N | Description The description of the configuration view and it cannot exceed 2500 characters. |
||||||||||||||||||
view-type | enum(view-type) | N | Y | Y | Y | Y | View Type There are four types of view types
Possible Values:
Default: FORMVIEW. |
||||||||||||||||||
creation-time | Date | Y | Y | N | Y | Y | Creation Time The time when the configuration view was created. Note : to filter the configuration view based on time should be given in millisecs. |
||||||||||||||||||
last-updated-time | Date | Y | Y | N | Y | Y | Last Updated Time The time when the configuration view was updated at last Note : to filter the configuration view based on time should be given in millisecs. |
||||||||||||||||||
last-modified-by | String | Y | Y | N | Y | Y | Last Modified user The name of the user who modified the configuration view at last. |
||||||||||||||||||
order | Integer | N | Y | Y * | Y | Y | Order Order of the configuration view tab in Device Configuration View UI. Min: 1 Max: 65535. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this configuration-xml node in the current node context. Hyperlink Template: /api/space/config-template-management/templates/{*ID}/quick-template- config. |
xml | String | N | Y | Y * | The content of the configuration template in XML format. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
xml | String | N | Y | Y * | Xml Data. |
Field Name | Type | Read Only | GET | PUT / POST | PATCH | Description | ||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | Link to this connection-profile node in the current node context. Hyperlink Template: /api/space/device-management/modeled-device-management/connection-profiles/{*ID}. |
||||||
@href | String(URI) | Y | Y | N | N | Link to an external connection-profile. Hyperlink Template: /api/space/device-management/modeled-device-management/connection-profiles/{*ID}. |
||||||
*id | Integer | Y | Y | N | N | ID of the connection profile. |
||||||
name | String | N | Y | Y * | Y | Name of the connection profile. |
||||||
description | String | N | Y | Y | Y | Description of connection profile. |
||||||
interface-type | enum(interface-type) | N | Y | Y | Y | Type of the interface for which the connection profile is being set. Possible Values:
Default: ETHERNET. |
||||||
interface-name | String | N | Y | Y | Y | Name of the interface for which the connection profile is being set. Default: "ge-0/0/0". |
||||||
ip-type | String | N | Y | Y | Y | System based parameter- Defines the ip type of connection profile. |
||||||
use-nat | Boolean | N | Y | Y | Y | Is JNAP server behind NAT [NAT enabled]. Default: false. |
||||||
type | String | N | Y | Y * | Y | The Connection type for the profile. |
||||||
dhcp-retransmission-attempt | Integer | N | Y | Y | Y | Dhcp parameter- Retransmission Attempt. Min: 1 Max: 6. |
||||||
dhcp-retransmission-interval | Integer | N | Y | Y | Y | Dhcp parameter- Retransmission Interval. Min: 1 Max: 64. |
||||||
dhcp-server-address | String | N | Y | Y | Y | Dhcp parameter- Server IP address. |
||||||
dhcp-update-server | Boolean | N | Y | Y | Y | Dhcp parameter- Update Server. |
||||||
dhcp-lease-never-expires | Boolean | N | Y | Y | Y | Dhcp parameter-Lease time never expires. |
||||||
dhcp-lease-time | Integer | N | Y | Y | Y | Dhcp parameter-custom Lease time. Min: 1 Max: 64. |
||||||
dhcp-default-lease | Boolean | N | Y | Y | Y | Dhcp parameter- Lease time set to default. |
||||||
auth-protocol-type | String | N | Y | Y | Y | Auth Protocol - CHAP/PAP. |
||||||
user-name | String | N | Y | Y | Y | The CHAP username. |
||||||
password | String | N | Y | Y | Y | The CHAP password. |
||||||
access-profile-user-name | String | N | Y | Y | Y | Access profile username. |
||||||
access-profile-password | String | N | Y | Y | Y | Access profile password. |
||||||
vpi | Integer | N | Y | Y | Y | The VPI(Virtual Path Identifier) in case of ADSL(ie PPPoA), values are changed based on ISPs. Min: 0 Max: 6000. |
||||||
vci | Integer | N | Y | Y | Y | The VCI(Virtual Channel Identifier) in case of ADSL(ie PPPoA), values are changed based on ISPs. Min: 0 Max: 6000. |
||||||
encapsulation-type | String | N | Y | Y | Y | Encapsulation Type for ADSL(ie PPPoA) - values atm-ppp-vc-mux & atm-ppp-llc. |
||||||
concentrator-name | String | N | Y | Y | Y | Concentrator name for PPPoE. |
||||||
service-name | String | N | Y | Y | Y | Service name. |
||||||
time-interval | Integer | N | Y | Y | Y | PPPoE parameter-auto connect time interval. Min: 0 Max: 6000. |
||||||
idle-period | Integer | N | Y | Y | Y | PPPoE parameter-ideal time before disconnect. Min: 0 Max: 6000. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this connection-profiles node in the current node context. |
@total | Integer | Y | Y | N | Total number of connection-profiles in the API result set. |
connection-profile | connection-profiles. | N | Y | Y * | Connection-profile which Contains connection-establishment parameters like ip details, NAT details, connection-type(DHCP,ADSL,PPPoaA,PPPoE) and its sub-parameters. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | N | Link to this connectionProfileMOREST node in the current node context. Hyperlink Template: /api/space/device-management/modeled-device-management/connection-profiles/{*ID}. |
@href | String(URI) | Y | Y | N | N | N | Link to an external connectionProfileMOREST. Hyperlink Template: /api/space/device-management/modeled-device-management/connection-profiles/{*ID}. |
id | Integer | Y | Y | N | N | N | ID of the connection profile. |
name | String | N | Y | Y | N | N | Name of the connection profile. |
type | String | N | Y | Y * | N | N | The Connection type (for example; DHCP, PPPoA, PPPoE, Static). |
description | String | N | Y | Y | N | N | Description of connection profile. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | N | Y | Y | Link to this connection-status node in the current node context. |
status | String | N | Y | Y |
Connection status of the device. |
Field Name | Type | Read Only | GET | PUT / POST | Description | ||||||
---|---|---|---|---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this create-connection-profile-dhcp-request node in the current node context. |
||||||
id | Integer | Y | Y | N | ID of the connection profile. |
||||||
name | String | N | Y | Y * | Name of the connection profile. |
||||||
description | String | N | Y | Y | Description of the connection profile. |
||||||
interface-type | enum(interface-type) | N | Y | Y | Type of the interface for which the connection profile is being set. Possible Values:
Default: ETHERNET. |
||||||
interface-name | String | N | Y | Y | Name of the interface for which the connection profile is being set. Default: "ge-0/0/0". |
||||||
ip-type | String | N | Y | Y | System based parameter- Defines the ip type of connection profile. |
||||||
use-nat | Boolean | N | Y | Y | Is JNAP server behind NAT [NAT enabled]. Default: false. |
||||||
dhcp-retransmission-attempt | Integer | N | Y | Y | Dhcp parameter- Retransmission Attempt. Default: 4 Min: 1 Max: 6. |
||||||
dhcp-retransmission-interval | Integer | N | Y | Y | Dhcp parameter- Retransmission Interval. Default: 4 Min: 1 Max: 64. |
||||||
dhcp-server-address | String | N | Y | Y | Dhcp parameter- Server IP address. |
||||||
dhcp-update-server | Boolean | N | Y | Y | Dhcp parameter- Update Server. |
||||||
dhcp-default-lease | Boolean | N | Y | Y | Dhcp parameter- Lease time set to default. |
||||||
dhcp-lease-never-expires | Boolean | N | Y | Y | Dhcp parameter-Lease time never expires. |
||||||
dhcp-lease-time | Integer | N | Y | Y | Dhcp parameter-custom Lease time. Min: 1 Max: 64. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this create-connection-profile-dhcp-response node in the current node context. |
connection-profile | create-connection-profile-dhcp-response. | N | Y | Y * | Connection profile details. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this connectionProfileMOREST node in the current node context. Hyperlink Template: /api/space/device-management/modeled-device-management/connection-profiles/{*ID}. |
@href | String(URI) | N | Y | Y * | Link to an external connectionProfileMOREST. Hyperlink Template: /api/space/device-management/modeled-device-management/connection-profiles/{*ID}. |
id | Integer | Y | Y | N | ID of the connection profile. |
name | String | Y | Y | N | Name of the connection profile. |
Field Name | Type | Read Only | GET | PUT / POST | Description | ||||||
---|---|---|---|---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this create-connection-profile-pppoa-request node in the current node context. |
||||||
id | Integer | Y | Y | N | ID of the connection profile. |
||||||
name | String | N | Y | Y * | Name of the connection profile. |
||||||
description | String | N | Y | Y | Description of the connection profile. |
||||||
interface-type | enum(interface-type) | N | Y | Y | Type of the interface for which the connection profile is being set. Possible Values:
Default: ADSL. |
||||||
interface-name | String | N | Y | Y | Name of the interface for which the connection profile is being set. Default: "at-1/0/0". |
||||||
ip-type | String | N | Y | Y | System based parameter- Defines the ip type of connection profile. |
||||||
use-nat | Boolean | N | Y | Y | Is JNAP server behind NAT [NAT enabled]. Default: false. |
||||||
auth-protocol-type | String | N | Y | Y | Auth Protocol CHAP or PAP. Default: "CHAP". |
||||||
user-name | String | N | Y | Y * | The CHAP username. |
||||||
password | String | N | Y | Y * | The CHAP password. |
||||||
access-profile-user-name | String | N | Y | Y | Access profile username. |
||||||
access-profile-password | String | N | Y | Y | Access profile password. |
||||||
vpi | Integer | N | Y | Y | The VPI(Virtual Path Identifier) in case of ADSL(ie PPPoA), values are changed based on ISPs. Default: 1 Min: 0 Max: 6000. |
||||||
vci | Integer | N | Y | Y | The VCI(Virtual Channel Identifier) in case of ADSL(ie PPPoA), values are changed based on ISPs. Default: 1 Min: 0 Max: 6000. |
||||||
encapsulation-type | String | N | Y | Y | Encapsulation Type for ADSL(ie PPPoA) - values atm-ppp-vc-mux & atm-ppp-llc. Default: "atm-ppp-vc-mux". |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this create-connection-profile-pppoa-response node in the current node context. |
connection-profile | create-connection-profile-pppoa-response. | N | Y | Y * | Connection profile details. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this connectionProfileMOREST node in the current node context. Hyperlink Template: /api/space/device-management/modeled-device-management/connection-profiles/{*ID}. |
@href | String(URI) | N | Y | Y * | Link to an external connectionProfileMOREST. Hyperlink Template: /api/space/device-management/modeled-device-management/connection-profiles/{*ID}. |
id | Integer | Y | Y | N | ID of the connection profile. |
name | String | Y | Y | N | Name of the connection profile. |
Field Name | Type | Read Only | GET | PUT / POST | Description | ||||||
---|---|---|---|---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this create-connection-profile-pppoe-request node in the current node context. |
||||||
id | Integer | Y | Y | N | ID of the connection profile. |
||||||
name | String | N | Y | Y * | Name of the connection profile. |
||||||
description | String | N | Y | Y | Description of the connection profile. |
||||||
interface-type | enum(interface-type) | N | Y | Y | Type of the interface for which the connection profile is being set. Possible Values:
Default: ETHERNET. |
||||||
interface-name | String | N | Y | Y | Name of the interface for which the connection profile is being set. Default: "ge-0/0/0". |
||||||
ip-type | String | N | Y | Y | System based parameter- Defines the ip type of connection profile. |
||||||
use-nat | Boolean | N | Y | Y | Is JNAP server behind NAT [NAT enabled]. Default: false. |
||||||
auth-protocol-type | String | N | Y | Y | Auth Protocol CHAP or PAP. Default: "CHAP". |
||||||
user-name | String | N | Y | Y * | The CHAP username. |
||||||
password | String | N | Y | Y * | The CHAP password. |
||||||
access-profile-user-name | String | N | Y | Y | Access profile username. |
||||||
access-profile-password | String | N | Y | Y | Access profile password. |
||||||
concentrator-name | String | N | Y | Y | Concentrator name for PPPoE. |
||||||
service-name | String | N | Y | Y | The service name. |
||||||
time-interval | Integer | N | Y | Y | PPPoE parameter-auto connect time interval. Default: 1 Min: 0 Max: 6000. |
||||||
idle-period | Integer | N | Y | Y | PPPoE parameter-ideal time before disconnect. Default: 1 Min: 0 Max: 6000. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this create-connection-profile-pppoe-response node in the current node context. |
connection-profile | create-connection-profile-pppoe-response. | N | Y | Y * | Connection profile details. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this connectionProfileMOREST node in the current node context. Hyperlink Template: /api/space/device-management/modeled-device-management/connection-profiles/{*ID}. |
@href | String(URI) | N | Y | Y * | Link to an external connectionProfileMOREST. Hyperlink Template: /api/space/device-management/modeled-device-management/connection-profiles/{*ID}. |
id | Integer | Y | Y | N | ID of the connection profile. |
name | String | Y | Y | N | Name of the connection profile. |
Field Name | Type | Read Only | GET | PUT / POST | Description | ||||||
---|---|---|---|---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this create-connection-profile-static-request node in the current node context. |
||||||
id | Integer | Y | Y | N | ID of the connection profile. |
||||||
name | String | N | Y | Y * | Name of the connection profile. |
||||||
description | String | N | Y | Y | Description of the connection profile. |
||||||
interface-type | enum(interface-type) | N | Y | Y | Type of the interface for which the connection profile is being set. Possible Values:
Default: ETHERNET. |
||||||
interface-name | String | N | Y | Y | Name of the interface for which the connection profile is being set. Default: "ge-0/0/0". |
||||||
ip-type | String | N | Y | Y | System based parameter- Defines the ip type of connection profile. |
||||||
use-nat | Boolean | N | Y | Y | Is JNAP server behind NAT [NAT enabled]. Default: false. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this create-connection-profile-static-response node in the current node context. |
connection-profile | create-connection-profile-static-response. | N | Y | Y * | Connection profile details. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this connectionProfileMOREST node in the current node context. Hyperlink Template: /api/space/device-management/modeled-device-management/connection-profiles/{*ID}. |
@href | String(URI) | N | Y | Y * | Link to an external connectionProfileMOREST. Hyperlink Template: /api/space/device-management/modeled-device-management/connection-profiles/{*ID}. |
id | Integer | Y | Y | N | ID of the connection profile. |
name | String | Y | Y | N | Name of the connection profile. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this ctps node in the current node context. |
@total | Integer | Y | Y | N | Total number of ctps in the API result set. |
ctp | ctps. | N | Y | Y * | Collection of Logical Interfaces of the Device(s). |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | N | Link to this deviceLogicalInterface node in the current node context. Hyperlink Template: /api/space/managed-domain/ctps/{*ID}. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
@href | String(URI) | Y | Y | N | N | N | Link to an external deviceLogicalInterface. Hyperlink Template: /api/space/managed-domain/ctps/{*ID}. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
vlan-id | String | Y | Y | N | Y | Y | Vlan ID of the Logical Interface. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
domain-id | Integer | Y | Y | N | Y | Y | Unique ID of the Domain to which the Device belongs to. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
description | String | Y | Y | N | Y | Y | Description of the Logical Interface. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
device-name | String | Y | Y | N | Y | Y | Name of the Device. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
domain-name | String | Y | Y | N | Y | Y | Name of the Domain to which the Device belongs to. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ipv6-address | String | Y | Y | N | Y | Y | IPv6 address of the Logical Interface. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
id | Integer | Y | Y | N | Y | Y | Unique ID of the Logical Interface. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
name | String | Y | Y | N | Y | Y | Name of the Logical Interface. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
encapsulation | enum(encapsulation) | Y | Y | N | Y | Y | Encapsulation of the Logical Interface. Possible Values:
Default: NONE. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ipv4-address | String | Y | Y | N | Y | Y | IPv4 address of the Logical Interface. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
device-id | Integer | Y | Y | N | Y | Y | Unique ID of the Device. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this customized-attribute-categories node in the current node context. |
@total | Integer | Y | Y | N | Total number of customized-attribute-categories in the API result set. |
customized-attribute-category | customized-attribute-categories. | N | Y | Y * |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | N | Link to this customizedAttributeCategory node in the current node context. Hyperlink Template: /api/space/tag-management/customized-attribute-categories/{*ID}. |
@href | String(URI) | Y | Y | N | N | N | Link to an external customizedAttributeCategory. Hyperlink Template: /api/space/tag-management/customized-attribute-categories/{*ID}. |
id | Integer | Y | Y | N | N | N | CustomizedAttributeCategory ID. |
category | String | N | Y | Y * | N | N | Category. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this customized-attribute-category node in the current node context. Hyperlink Template: /api/space/tag-management/customized-attribute-categories/{*ID}. |
@href | String(URI) | Y | Y | N | Link to an external customized-attribute-category. Hyperlink Template: /api/space/tag-management/customized-attribute-categories/{*ID}. |
*id | Integer | Y | Y | N | CustomizedAttributeCategory ID. |
category | String | N | Y | Y * | Category. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this customized-attribute-label node in the current node context. Hyperlink Template: /api/space/tag-management/customized-attribute-labels/{*ID}. |
@href | String(URI) | Y | Y | N | Link to an external customized-attribute-label. Hyperlink Template: /api/space/tag-management/customized-attribute-labels/{*ID}. |
*id | Integer | Y | Y | N | CustomizedAttributeLabel ID. |
promoted-column-index | Integer | N | Y | Y * | Promoted Column Index. |
customized-attribute-category | customized-attribute-label. | N | Y | Y | |
name | String | N | Y | Y * | CustomizedAttributeLabel Name. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@href | String(URI) | N | Y | Y * | Link to an external customizedAttributeCategory. Hyperlink Template: /api/space/tag-management/customized-attribute-categories/{*ID}. |
id | Integer | Y | Y | N | CustomizedAttributeCategory ID. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this customized-attribute-labels node in the current node context. |
@total | Integer | Y | Y | N | Total number of customized-attribute-labels in the API result set. |
customized-attribute-label | customized-attribute-labels. | N | Y | Y * |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | N | Link to this customizedAttributeLabel node in the current node context. Hyperlink Template: /api/space/tag-management/customized-attribute-labels/{*ID}. |
@href | String(URI) | Y | Y | N | N | N | Link to an external customized-attribute-label. Hyperlink Template: /api/space/tag-management/customized-attribute-labels/{*ID}. |
id | Integer | Y | Y | N | N | N | CustomizedAttributeLabel ID. |
promoted-column-index | Integer | N | Y | Y * | N | N | Promoted Column Index. |
customized-attribute-category | customized-attribute-labels. | N | Y | Y | N | N | |
name | String | N | Y | Y * | N | N | CustomizedAttributeLabel Name. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@href | String(URI) | N | Y | Y * | Link to an external customizedAttributeCategory. Hyperlink Template: /api/space/tag-management/customized-attribute-categories/{*ID}. |
id | Integer | Y | Y | N | CustomizedAttributeCategory ID. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this customized-attribute-value node in the current node context. |
id | Integer | Y | Y | N | CustomizedAttributeValue ID. |
value | String | N | Y | Y * | Value. |
customized-attribute-label | customized-attribute-value. | N | Y | Y * |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@href | String(URI) | N | Y | Y * | Link to an external customizedAttributeLabel. Hyperlink Template: /api/space/tag-management/customized-attribute-labels/{*ID}. |
id | Integer | Y | Y | N | CustomizedAttributeLabel ID. |
name | String | Y | Y | N | CustomizedAttributeLabel Name. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this customized-attribute-value-refs node in the current node context. |
@total | Integer | Y | Y | N | Total number of customized-attribute-values in the API result set. |
customized-attribute-value | customized-attribute-value-refs. | N | Y | Y * |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@href | String(URI) | N | Y | Y * | N | N | Link to an external customizedAttributeValue. Hyperlink Template: /api/space/device-management/devices/{*ID}/customized-attribute-values/{*ID}. |
id | Integer | Y | Y | N | Y | Y | CustomizedAttributeValue ID. |
entity-row-id | Integer | Y | Y | N | N | N | Entity Row ID. |
value | String | Y | Y | N | Y | Y | Value. |
customized-attribute-label | customized-attribute-value-refs. | Y | Y | N | N | N |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@href | String(URI) | N | Y | Y * | Link to an external customizedAttributeLabel. Hyperlink Template: /api/space/tag-management/customized-attribute-labels/{*ID}. |
id | Integer | Y | Y | N | CustomizedAttributeLabel ID. |
name | String | Y | Y | N | CustomizedAttributeLabel Name. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
version-list | delete-config-template-versions-request. | N | Y | Y * | list of versions to be deleted. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this versionLists node in the current node context. |
version | Integer[] | N | Y | Y * | Version Lists. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
template-id-with-ver | delete-config-template-with-versions-request. | N | Y | Y * |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this templateIdWithVers node in the current node context. |
template-id-with-ver | String[] | N | Y | Y * | Template ID With Vers. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
device-discovery-rules | delete-device-discovery-rules-request. | N | Y | Y * |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this deviceTargetRules node in the current node context. |
device-discovery-rule | delete-device-discovery-rules-request. | N | Y | Y * |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@href | String(URI) | N | Y | Y * | N | N | Link to an external device-discovery-rule. Hyperlink Template: /api/space/device-management/device-discovery-rules/{*ID}. |
id | Integer | Y | Y | N | Y | Y | DeviceDiscoveryRule ID. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
value | String | N | Y | Y * | Value. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this delete-devices-job-results node in the current node context. |
@total | Integer | Y | Y | N | Total number of delete-devices-job-results in the API result set. |
delete-device-job-result | delete-devices-job-results. | N | Y | Y * | Delete Device Job Result Entry. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description | ||||
---|---|---|---|---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | N | Link to this deleteDeviceResult node in the current node context. |
||||
id | Integer | Y | Y | N | N | N | Job result table row ID. |
||||
delete-fail-reason | String | N | Y | Y * | Y | N | If device Delete failed, set the fail reason. |
||||
device | delete-devices-job-results. | N | Y | Y * | N | N | |||||
delete-device-status | enum(delete-device-status) | N | Y | Y * | Y | Y | Delete device status. Possible Values:
|
||||
hostname | String | N | Y | Y | Y | Y | Hostname. |
||||
device-id | Integer | N | Y | Y * | Y | Y | device id. |
||||
ip | String | N | Y | Y | Y | N | ip address. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@href | String(URI) | N | Y | Y * | Link to an external device. Hyperlink Template: /api/space/managed-domain/devices-require-polling/{*ID}. |
id | Integer | Y | Y | N | Device ID. |
name | String | Y | Y | N | Device Name. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
devices | delete-devices-request. | N | Y | Y * | Devices to be deleted. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this deviceLists node in the current node context. |
device | delete-devices-request. | N | Y | Y * | Device to be deleted. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@href | String(URI) | N | Y | Y * | N | N | Link to an external device. Hyperlink Template: /api/space/device-management/devices/{*ID}. |
id | Integer | Y | Y | N | Y | Y | Device ID. |
name | String | Y | Y | N | Y | Y | Device Name. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this delete-domain-job-results node in the current node context. |
@total | Integer | Y | Y | N | Total number of delete-domain-job-results in the API result set. |
delete-domain-job-result | delete-domain-job-results. | N | Y | Y * |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | N | Link to this deleteDomainJobResult node in the current node context. |
application-name | String | N | Y | Y * | Y | N | Application Name. |
id | Integer | Y | Y | N | N | N | Domain ID. |
description | String | N | Y | Y * | N | N | Description. |
domain-name | String | Y | Y | N | N | N | Domain Name. |
job-instance-id | Integer | N | Y | Y * | N | N | Job Instance ID. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this delete-fabric-node-request node in the current node context. |
fabric-node | delete-fabric-node-request. | N | Y | Y * | The Fabric node which has to be deleted. |
alternative-fabric-node | delete-fabric-node-request. | N | Y | Y | The details about the non load balancer node which will be configured by Junos Space server as a replacement for the node which will be deleted. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@href | String(URI) | N | Y | Y * | Link to an external fabricNode. Hyperlink Template: /api/space/fabric-management/fabric-nodes/{*ID}. |
id | Integer | Y | Y | N | Fabric Node ID. |
name | String | Y | Y | N | Logical name assigned to the node
NOTE: For the first node, Junos Space uses the node name that the user
specifies during the initial configuration of the Junos Space Appliance
(physical or virtual). |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@href | String(URI) | N | Y | Y * | Link to an external alternativeNode. Hyperlink Template: /api/space/fabric-management/fabric-nodes/{*ID}. |
id | Integer | Y | Y | N | Fabric Node ID. |
name | String | Y | Y | N | Logical name assigned to the node
NOTE: For the first node, Junos Space uses the node name that the user
specifies during the initial configuration of the Junos Space Appliance
(physical or virtual). |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
fabric-hprof-files | delete-hprof-files-request. | N | Y | Y * |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this fabricHprofFiles node in the current node context. |
fabric-hprof-file | delete-hprof-files-request. | N | Y | Y * |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@href | String(URI) | N | Y | Y * | N | N | Link to an external fabric-hprof-file. Hyperlink Template: /api/space/fabric-management/hprof-files/{*ID}. |
id | Integer | Y | Y | N | N | N | ID. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
dmi-schema-infos | delete-schemas. | N | Y | Y * | List of schemas to delete. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this dmiSchemaInfos node in the current node context. |
dmi-schema-info | delete-schemas. | N | Y | Y * | Specify a device family and an os version (release) for each schema to be deleted. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | N | Link to this dmiSchemaInfo node in the current node context. |
os-version | String | N | Y | Y * | Y | N | Release/OS Version. |
dev-family | String | N | Y | Y * | Y | N | Device Family. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
jobs | denied-jobs-request. | N | Y | Y * |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this instanceManagedObjects node in the current node context. |
job | denied-jobs-request. | N | Y | Y * |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@href | String(URI) | N | Y | Y * | N | N | Link to an external monitorableTaskInstanceManagedObject. Hyperlink Template: /api/space/job-management/jobs/{*ID}. |
id | Integer | Y | Y | N | Y | Y | The ID of the job. |
name | String | Y | Y | N | N | N | MonitorableTaskInstanceManagedObject Name. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this deploy-configuration-job-results node in the current node context. |
@total | Integer | Y | Y | N | Total number of deploy-configuration-job-results in the API result set. |
deploy-configuration-job-result | deploy-configuration-job-results. | N | Y | Y * | Deploy Configuration job result detail. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description | ||||
---|---|---|---|---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | N | Link to this consolidatedConfigJobResult node in the current node context. |
||||
id | Integer | Y | Y | N | Y | Y | Job result table row ID. |
||||
ip | String | Y | Y | N | Y | Y | IP. |
||||
host-name | String | Y | Y | N | Y | Y | Host Name. |
||||
device-id | Integer | Y | Y | N | Y | Y | Device ID. |
||||
status | enum(status) | Y | Y | N | Y | Y | Status. Possible Values:
|
||||
job-instance-id | Integer | Y | Y | N | Y | Y | Job Instance ID. |
||||
job-failed-reason | String | Y | Y | N | N | N | Job Failed Reason. |
||||
deploy-data | String | Y | Y | N | N | N | Deploy Data. |
||||
device | String | Y | Y | N | N | N | Device Link Hyperlink Template: /api/space/device-management/devices/{*ID}. |
||||
job | String | Y | Y | N | N | N | Job Link Hyperlink Template: /api/space/job-management/jobs/{*ID}. |
Field Name | Type | Read Only | GET | PUT / POST | Description | ||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
@uri | String(URI) | N | Y | Y * | Link to this device node in the current node context. |
||||||||||||||||||||||||||||||||||||
deviceFamily | String | N | Y | Y |
Device family that the device belongs to (for example, MX). |
||||||||||||||||||||||||||||||||||||
OSVersion | String | N | Y | Y | OS version of the device | ||||||||||||||||||||||||||||||||||||
platform | String | N | Y | Y | Platform of the device | ||||||||||||||||||||||||||||||||||||
serialNumber | String | N | Y | Y |
Serial number of the device. |
||||||||||||||||||||||||||||||||||||
name | String | N | Y | Y |
Name of the device. |
||||||||||||||||||||||||||||||||||||
hostName | String | N | Y | Y |
Host Name of the device. |
||||||||||||||||||||||||||||||||||||
id | Integer | N | Y | Y * |
Unique identifier for the 'device'. |
||||||||||||||||||||||||||||||||||||
ipAddr | String | N | Y | Y |
IP Address of the device. |
||||||||||||||||||||||||||||||||||||
otp | String | N | Y | Y |
OTP connection of the device. |
||||||||||||||||||||||||||||||||||||
domain-id | Integer | N | Y | Y |
domain id of device. |
||||||||||||||||||||||||||||||||||||
domain-name | String | N | Y | Y |
domain name of the device. |
||||||||||||||||||||||||||||||||||||
connection-type | String | N | Y | Y | Connection type of the Device | ||||||||||||||||||||||||||||||||||||
attribute-column-0 | String | N | Y | Y | Custom Attribute for Device. |
||||||||||||||||||||||||||||||||||||
use-nat | boolean | N | Y | Y * | An attribute that describes the device is connected to NAT or not. |
||||||||||||||||||||||||||||||||||||
authentication-status | enum(authentication-status) | N | Y | Y |
Authentication status of the Device
Possible Values:
|
||||||||||||||||||||||||||||||||||||
device-id | int | N | Y | Y | Unique Identifier of Device | ||||||||||||||||||||||||||||||||||||
web-mgmt | String | N | Y | Y | Web management protocol | ||||||||||||||||||||||||||||||||||||
lsys-count | int | N | Y | Y | Device Lsys Count | ||||||||||||||||||||||||||||||||||||
rootLsys | DeviceDO | N | Y | Y | Device Lsys Root | ||||||||||||||||||||||||||||||||||||
hosting-deviceId | int | N | Y | Y | Hosting Device ID | ||||||||||||||||||||||||||||||||||||
adapter-name | String | N | Y | Y | Name of the Adapter used for Device discovery | ||||||||||||||||||||||||||||||||||||
config-status | enum(config-status) | N | Y | Y |
Config Status
Possible Values:
|
||||||||||||||||||||||||||||||||||||
device-type | enum(device-type) | N | Y | Y | Device Type. Possible Values:
|
||||||||||||||||||||||||||||||||||||
schema-version | String | N | Y | Y |
schema verision of the device. |
||||||||||||||||||||||||||||||||||||
change-requests | device. | N | Y | Y |
Change-requests for the respective device. |
||||||||||||||||||||||||||||||||||||
managed-elements | device. | N | Y | Y |
Managed elements of the device. |
||||||||||||||||||||||||||||||||||||
connection-status | device. | N | Y | Y | Active connection Status of the device | ||||||||||||||||||||||||||||||||||||
managed-status | device. | N | Y | Y | Managed status of the device | ||||||||||||||||||||||||||||||||||||
configurations | String | N | Y | Y |
Location of 'configuration' resource. |
||||||||||||||||||||||||||||||||||||
rpc | String | N | Y | Y |
Location of 'rpc' resource. |
||||||||||||||||||||||||||||||||||||
config-files | String | N | Y | Y |
Location of 'config-files' resource. |
||||||||||||||||||||||||||||||||||||
associated-scripts | String | N | Y | Y |
The association of device to scripts. |
||||||||||||||||||||||||||||||||||||
associated-softwares | String | N | Y | Y |
The association of device to softwares. |
||||||||||||||||||||||||||||||||||||
activate-modeled-device | String | N | Y | Y |
Activate modeled device. |
||||||||||||||||||||||||||||||||||||
clone | String | N | Y | Y |
Clone device. |
||||||||||||||||||||||||||||||||||||
modify-device-target-ip | String | N | Y | Y |
Modify Target IP. |
||||||||||||||||||||||||||||||||||||
configlet | String | N | Y | Y |
view configlet. |
||||||||||||||||||||||||||||||||||||
domain | String | Y | Y | N | |||||||||||||||||||||||||||||||||||||
apply-cli-configlet | String | Y | Y | N | |||||||||||||||||||||||||||||||||||||
submit-cli-configlet | String | Y | Y | N | |||||||||||||||||||||||||||||||||||||
compute-configlet-parameter-values | String | Y | Y | N | |||||||||||||||||||||||||||||||||||||
applicable-configlets | String | Y | Y | N | |||||||||||||||||||||||||||||||||||||
validate-cli-configlet | String | Y | Y | N | |||||||||||||||||||||||||||||||||||||
customized-attribute-values | String | Y | Y | N |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | N | Y | Y * | Link to this changeRequests node in the current node context. |
change-request | device. | N | Y | Y |
The collection of objects of type 'change-request'. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@href | String(URI) | N | Y | Y * | N | N | Link to an external changeRequest. |
@uri | String(URI) | N | Y | Y * | N | N | Link to this changeRequest node in the current node context. |
@key | Integer | N | Y | Y * | N | N |
Unique identifier for the change request. |
deviceId | Long | N | Y | Y * | N | N |
Unique identifier for device. |
name | String | N | Y | Y | N | N |
The change-request name. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | N | Y | Y * | Link to this managedElements node in the current node context. |
managed-element | device. | N | Y | Y |
A collection of managed elements. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@href | String(URI) | N | Y | Y * | N | N | Link to an external managedElementDTO. |
id | Integer | N | Y | Y * | N | N |
Unique identifier for the managed element. |
ipAddr | String | N | Y | Y | N | N |
IP Address of the device. |
deviceId | Integer | N | Y | Y | N | N |
Unique identifier for device. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | N | Y | Y * | Link to this connectionStatus node in the current node context. |
status | String | N | Y | Y |
Connection status of device. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | N | Y | Y * | Link to this managedStatus node in the current node context. |
status | String | N | Y | Y |
Status of device (for example, 'out-of-sync' or 'In-sync'). |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | N | Y | Y | Link to this device node in the current node context. |
auto-log-in-to-devices | String | N | Y | Y |
Whether to enable or disable the auto-login to devices. |
auto-resync | String | N | Y | Y |
Whether to resynchronize devices automatically or not. |
auto-resync-waiting-time | Integer | N | Y | Y |
Waiting time in minutes for the auto-resynchronization of devices. |
initiates-connection | String | N | Y | Y |
Server initiated connection. |
support-ww | String | N | Y | Y |
Whether WorldWide Junos OS adapter is supported or not. |
ssh-port | Integer | N | Y | Y |
SSH port for the device. |
polling-time | Integer | N | Y | Y |
Time in minutes to poll the device. |
commit-confirmed-for-configuration | Boolean | N | Y | Y | Enable commit confirmed for configuration deployment |
approval-workflow-for-config | Boolean | N | Y | Y |
Enable approval workflow for configuration deployment. |
allow-device-communication | Boolean | N | Y | Y |
Allow Device Communication. |
support-abort-for-close-session | Boolean | N | Y | Y |
Support Abort For Close Session. |
looking-glass-response-timeout | Integer | N | Y | Y |
Looking Glass Device response timeout in seconds. |
number-of-device-to-connect-for-space-initiated | Integer | N | Y | Y |
Number of devices to connect per minute for Space Initiated Connection. |
configure-commit-sync-during-device-discovery | Boolean | N | Y | Y |
Configure commit synchronize during device discovery. |
add-snmp-configuration | Boolean | N | Y | Y |
Add SNMP configuration to device. |
disable-network-monitoring | Boolean | N | Y | Y |
Disable network monitoring for all devices. |
manually-resolve-fingerprint-conflict | Boolean | N | Y | Y |
Support Manually Resolve Fingerprint Conflict. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | N | Y | Y | Link to this device-associations node in the current node context. |
@total | Integer | Y | Y | N | Total number of device-associations in the API result set. |
device-association | device-associations. | N | Y | Y * | The association between a device and a configuration template. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description | ||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
@uri | String(URI) | N | Y | Y | N | N | Link to this templateDeviceAssociation node in the current node context. |
||||||
device-name | String | N | Y | Y * | Y | N | The name of the device. |
||||||
current-template-ver | Integer | N | Y | Y * | N | N | The current version of the template. |
||||||
deploy-status | enum(deploy-status) | N | Y | Y * | N | N | The status of the last deployment. Possible Values:
|
||||||
audit-status | enum(audit-status) | N | Y | Y * | Y | Y | The status of last audit (exec-audit). Possible Values:
|
||||||
template-version | Integer | N | Y | Y * | Y | N | The version of the configuration template deployed to this device. |
||||||
published-template-version | Integer | N | Y | Y * | N | N | The version of the configuration template published to this device. |
||||||
deployed-by | String | N | Y | Y | Y | N | The user who deployed the configuration template. |
||||||
domain-id | Integer | N | Y | Y * | N | Y | The ID of the domain to which the device belongs. |
||||||
domain-name | String | N | Y | Y * | N | N | The name of the domain to which the device belongs. |
||||||
audit-job-id | Integer | N | Y | Y * | Y | N | The ID of the audit job. |
||||||
job-id | Integer | N | Y | Y * | Y | N | The ID of the job. |
||||||
publish-status | enum(publish-status) | N | Y | Y * | N | N | The status of last publish. Possible Values:
|
||||||
order-seq | Integer | N | Y | Y * | N | N | An ordinal sequence of template publishing to a candidate configuration. |
||||||
device-id | Integer | N | Y | Y * | Y | N | The ID of the device. |
||||||
device | String | Y | Y | N | N | N | The device associated with this template Hyperlink Template: /api/space/device-management/devices/{*ID}. |
||||||
deployment-job | String | Y | Y | N | N | N | The job used when the template was last deployed to this device Hyperlink Template: /api/space/job-management/jobs/{*ID}. |
||||||
audit-job | String | Y | Y | N | N | N | The job used when the template was last audited Hyperlink Template: /api/space/job-management/jobs/{*ID}. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this device-associations node in the current node context. |
@total | Integer | Y | Y | N | Total number of device-associations-for-template-versions in the API result set. |
device-template | device-associations. | N | Y | Y * |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description | ||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | N | Link to this deviceTemplate node in the current node context. |
||||||||||||||||||||||||||||||||||||
platform | String | N | Y | Y * | Y | Y | Platform. |
||||||||||||||||||||||||||||||||||||
device-ip | String | N | Y | Y * | Y | Y | Device IP. |
||||||||||||||||||||||||||||||||||||
device-name | String | N | Y | Y | Y | Y | Device Name. |
||||||||||||||||||||||||||||||||||||
id | String | N | Y | Y | N | N | MOID. |
||||||||||||||||||||||||||||||||||||
template-status | String | N | Y | Y * | N | N | Template Status. |
||||||||||||||||||||||||||||||||||||
software-release | String | N | Y | Y * | Y | Y | Software Release. |
||||||||||||||||||||||||||||||||||||
status | String | N | Y | Y * | Y | Y | Status. |
||||||||||||||||||||||||||||||||||||
template-ver | Integer | N | Y | Y * | N | N | Template Ver. |
||||||||||||||||||||||||||||||||||||
config-status | enum(config-status) | N | Y | Y * | N | N | Config Status. Possible Values:
|
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this device-by-ids node in the current node context. |
@total | Integer | Y | Y | N | Total number of device-by-ids in the API result set. |
device | device-by-ids. | N | Y | Y * |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description | ||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | N | Link to this device node in the current node context. Hyperlink Template: /{*ID}. |
||||||||||||||||||||||||||||||||||||
@href | String(URI) | Y | Y | N | N | N | Link to an external device. Hyperlink Template: /api/space/managed-domain/devices-require-polling/{*ID}. |
||||||||||||||||||||||||||||||||||||
OSVersion | String | N | Y | Y | Y | Y | OS Version. |
||||||||||||||||||||||||||||||||||||
status | String | Y | Y | N | Y | Y | Status. |
||||||||||||||||||||||||||||||||||||
lsys-count | Integer | N | Y | Y | N | N | Lsys Count. |
||||||||||||||||||||||||||||||||||||
dev-admin | String | Y | Y | N | N | N | Dev Admin. |
||||||||||||||||||||||||||||||||||||
software-release | String | Y | Y | N | Y | Y | Software Release. |
||||||||||||||||||||||||||||||||||||
discovery-ip | String | Y | Y | N | N | N | Discovery IP. |
||||||||||||||||||||||||||||||||||||
hosting-deviceId | Integer | N | Y | Y | N | N | Hosting Device ID. |
||||||||||||||||||||||||||||||||||||
device-connection-type | String | Y | Y | N | N | N | Device Connection Type. |
||||||||||||||||||||||||||||||||||||
newFingerprint | String | N | Y | Y | N | N | Dev Conflict Fingerprint. |
||||||||||||||||||||||||||||||||||||
virtual-chassis-status | Boolean | Y | Y | N | N | N | Virtual Chassis Status. |
||||||||||||||||||||||||||||||||||||
fingerprint | String | N | Y | Y | N | N | Dev Fingerprint. |
||||||||||||||||||||||||||||||||||||
ipAddr | String | N | Y | Y | Y | Y | IP Addr. |
||||||||||||||||||||||||||||||||||||
vendor | String | Y | Y | N | Y | Y | Vendor. |
||||||||||||||||||||||||||||||||||||
device-uuid | device-by-ids. | Y | Y | N | N | N | |||||||||||||||||||||||||||||||||||||
adapter-name | String | Y | Y | N | N | N | Adapter Name. |
||||||||||||||||||||||||||||||||||||
device-type | String | Y | Y | N | N | N | Device Type. |
||||||||||||||||||||||||||||||||||||
device-ip | String | Y | Y | N | Y | Y | Device IP. |
||||||||||||||||||||||||||||||||||||
authentication-status | enum(authentication-status) | Y | Y | N | Y | Y | Authentication Status. Possible Values:
|
||||||||||||||||||||||||||||||||||||
original-platform | String | Y | Y | N | N | N | Original Platform. |
||||||||||||||||||||||||||||||||||||
platform | String | N | Y | Y | Y | Y | Platform. |
||||||||||||||||||||||||||||||||||||
dev-admin-passwd | String | Y | Y | N | N | N | Dev Admin Passwd. |
||||||||||||||||||||||||||||||||||||
staged-status-from-view | enum(staged-status-from-view) | Y | Y | N | Y | Y | Staged Status From View. Possible Values:
|
||||||||||||||||||||||||||||||||||||
domain-id | Integer | Y | Y | N | N | Y | Domain ID. |
||||||||||||||||||||||||||||||||||||
logical-interfaces | String | Y | Y | N | N | N | Logical Interfaces. |
||||||||||||||||||||||||||||||||||||
matching-schema | String | Y | Y | N | N | Y | Matching Schema. |
||||||||||||||||||||||||||||||||||||
id | Integer | Y | Y | N | Y | Y | Id of the device. |
||||||||||||||||||||||||||||||||||||
name | String | Y | Y | N | Y | Y | Name of the device. |
||||||||||||||||||||||||||||||||||||
staged-status | enum(staged-status) | Y | Y | N | N | N | Staged Status. Possible Values:
|
||||||||||||||||||||||||||||||||||||
display-name | String | Y | Y | N | Y | Y | Display Name. |
||||||||||||||||||||||||||||||||||||
domain-name | String | Y | Y | N | N | N | Domain Name. |
||||||||||||||||||||||||||||||||||||
device-family | String | Y | Y | N | Y | Y | Device Family. |
||||||||||||||||||||||||||||||||||||
config-status | enum(config-status) | Y | Y | N | N | N | Config Status. Possible Values:
Default: DEVICE_STATE_UNDEF. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this deviceUUID node in the current node context. |
category | String | N | Y | Y * | Category. |
service | String | N | Y | Y * | Service. |
row-id | Integer | Y | Y | N | Row ID. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
device-ids | device-by-ids-request. | Y | Y | N | contains list device Id tag. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this deviceIds node in the current node context. |
device-id | String[] | N | Y | Y * | Device Id. |
Field Name | Type | Read Only | GET | PUT / POST | PATCH | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | Link to this device-discovery-rule node in the current node context. Hyperlink Template: /api/space/device-management/device-discovery-rules/{*ID}. |
||||||||||||
@href | String(URI) | Y | Y | N | N | Link to an external device-discovery-rule. Hyperlink Template: /api/space/device-management/device-discovery-rules/{*ID}. |
||||||||||||
*id | Integer | Y | Y | N | N | DeviceDiscoveryRule ID. |
||||||||||||
discovery-profile-name | String | N | Y | Y | Y | Discovery Profile Name. |
||||||||||||
target-details | String | N | Y | Y | Y | Target details (10. |
||||||||||||
use-nat | Boolean | N | Y | Y * | Y | useNAT flag. Default: false. |
||||||||||||
use-ping | Boolean | N | Y | Y | Y | usePing flag. Default: false. |
||||||||||||
sharable | Boolean | N | Y | Y | Y | Profile sharable status. Default: true. |
||||||||||||
use-snmp | Boolean | N | Y | Y | Y | useSnmp flag. Default: false. |
||||||||||||
discovery-job-details | device-discovery-rule. | N | Y | Y | Y | |||||||||||||
discovery-type | enum(discovery-type) | N | Y | Y | Y | Discovery type (i. Possible Values:
Default: IP_ADDRESS. |
||||||||||||
device-targets | device-discovery-rule. | N | Y | Y * | Y | |||||||||||||
device-snmp-version | enum(device-snmp-version) | N | Y | Y | Y | SNMP version. Possible Values:
|
||||||||||||
device-snmp-details | device-discovery-rule. | N | Y | Y | Y | |||||||||||||
domain-id | Integer | Y | Y | N | N | Domain ID. |
||||||||||||
domain-name | String | Y | Y | N | N | Domain Name. |
||||||||||||
discovery-action-additional-params | device-discovery-rule. | N | Y | Y | Y | Discovery Action additional parameter configuration. |
||||||||||||
is-run-now | Boolean | Y | Y | N | N | Is discovery job is of run now type flag. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@href | String(URI) | N | Y | Y * | Link to an external monitorableTaskInstanceManagedObject. Hyperlink Template: /api/space/job-management/jobs/{*ID}. |
id | Integer | Y | Y | N | MonitorableTaskInstanceManagedObject ID. |
name | String | Y | Y | N | MonitorableTaskInstanceManagedObject Name. |
scheduled-start-time-string | String | Y | Y | N | Scheduled Start Time String REST. |
schedule-string | String | Y | Y | N | Schedule String. |
supports-recurrence | Boolean | Y | Y | N | Supports Recurrence. Default: false. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this deviceTargets node in the current node context. Hyperlink Template: /api/space/device-management/device-discovery-rules/{*ID}/device-targets. |
device-target | device-discovery-rule. | N | Y | Y * |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | N | Link to this deviceTarget node in the current node context. |
id | Integer | Y | Y | N | N | N | Id of device Target. |
ip-address | String | N | Y | Y | N | N | ip-address of device to be discovered. |
host-name | String | N | Y | Y | N | N | Host name of device to be discovered. |
base-ip | String | N | Y | Y | N | N | Network ip of a network to be discovered. |
subnet-mask | String | N | Y | Y | N | N | Sub-net mask of the above mentioned network. |
lower-ip | String | N | Y | Y | N | N | Lower ip address of a network to be discovered. |
upper-ip | String | N | Y | Y | N | N | upper ip address of a network to be discovered. |
tags | device-discovery-rule. | N | Y | Y | N | N | |
device-ssh-credentials | device-discovery-rule. | N | Y | Y * | N | N | |
device-fingerprints | device-discovery-rule. | N | Y | Y | N | N |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this tagLists node in the current node context. |
tag | String[] | N | Y | Y * | Tag. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this deviceSshCredentials node in the current node context. Hyperlink Template: /api/space/device-management/device-discovery-rules/{*ID}/device-targets/device-ssh-credentials. |
@total | Integer | Y | Y | N | Total number of gen_device-discovery-rule-device-targets-device-targets-device-ssh-credentials in the API result set. |
device-ssh-credential | device-discovery-rule. | N | Y | Y * |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description | ||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | N | Link to this deviceSshCredential node in the current node context. |
||||||
id | Integer | Y | Y | N | N | N | Device credential id. |
||||||
username | String | N | Y | Y * | N | N | Name of user on the node used for authentication while discovery. |
||||||
password | String | N | Y | Y * | N | N | Password for authentication. |
||||||
keybased | Boolean | N | Y | Y | N | N | True to enable key-based authentication. Default: false. |
||||||
credential-type | enum(credential-type) | N | Y | Y | N | N | Credential Type. Possible Values:
|
||||||
pass-phrase | String | N | Y | Y | N | N | Pass Phrase. |
||||||
private-key | String | N | Y | Y | N | N | Private Key. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this deviceFingerprints node in the current node context. Hyperlink Template: /api/space/device-management/device-discovery-rules/{*ID}/device-targets/device-fingerprints. |
@total | Integer | Y | Y | N | Total number of gen_device-discovery-rule-device-targets-device-targets-device-fingerprints in the API result set. |
device-fingerprint | device-discovery-rule. | N | Y | Y |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | N | Link to this deviceTargetFingerprint node in the current node context. |
host-name | String | N | Y | Y * | N | N | Name of the node. |
id | Integer | Y | Y | N | N | N | Id of the finger print entity. |
fingerprint | String | N | Y | Y * | N | N | device fingerprint. |
Field Name | Type | Read Only | GET | PUT / POST | Description | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this deviceSnmpDetail node in the current node context. |
||||||||||
snmpv1v2c-community | String | N | Y | Y * | SNMPV1/V2C Community name. |
||||||||||
user-name | String | N | Y | Y * | SNMPV3 username. |
||||||||||
snmp-auth-type | enum(snmp-auth-type) | N | Y | Y * | Authentication type of SNMPv3 Possible values : MD5, SHA1 or NONE;. Possible Values:
|
||||||||||
authentication-password | String | N | Y | Y * | Password for SNMPv3 authentication. |
||||||||||
privacy-type | enum(privacy-type) | N | Y | Y * | Encryption methods to be used while discovery
Possible values: AES128, AES192, AES256, DES or NONE. Possible Values:
|
||||||||||
id | Integer | N | Y | Y | Device SNMP details id. |
||||||||||
privacy-password | String | N | Y | Y * | key word to be used for encryption. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this discoveryActionParams node in the current node context. |
discovery-action-additional-param | device-discovery-rule. | N | Y | Y * | Discovery Action additional parameter. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | N | Link to this discoveryTriggerActionParam node in the current node context. |
parameter | String | N | Y | Y * | N | N | Parameter will act as a key. |
parameter-value | String | N | Y | Y * | N | N | ParameterValue will act as a value for the key. |
Field Name | Type | Read Only | GET | PUT / POST | PATCH | Description |
---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | Link to this device-discovery-rules node in the current node context. |
@total | Integer | Y | Y | N | N | Total number of device-discovery-rules in the API result set. |
device-discovery-rule | device-discovery-rules. | N | Y | Y * | Y |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
@href | String(URI) | Y | Y | N | N | N | Link to an external device-discovery-rule. Hyperlink Template: /api/space/device-management/device-discovery-rules/{*ID}. |
||||||||||||
id | Integer | Y | Y | N | Y | Y | DeviceDiscoveryRule ID. |
||||||||||||
discovery-profile-name | String | N | Y | Y | Y | Y | Discovery Profile Name. |
||||||||||||
discovery-type | enum(discovery-type) | N | Y | Y | Y | Y | Discovery type (i. Possible Values:
Default: IP_ADDRESS. |
||||||||||||
sharable | Boolean | N | Y | Y | N | N | Profile sharable status. Default: true. |
||||||||||||
profile-owner | String | N | Y | Y | N | N | Profile owner. |
||||||||||||
discovery-job-details | device-discovery-rules. | N | Y | Y | N | N | |||||||||||||
target-details | String | N | Y | Y | Y | Y | Target details (10. |
||||||||||||
device-snmp-version | enum(device-snmp-version) | N | Y | Y | Y | Y | SNMP version. Possible Values:
|
||||||||||||
device-targets | device-discovery-rules. | N | Y | Y * | N | N | |||||||||||||
domain-name | String | Y | Y | N | N | N | Domain Name. |
||||||||||||
domain-id | Integer | Y | Y | N | N | Y | Domain ID. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@href | String(URI) | N | Y | Y * | Link to an external monitorableTaskInstanceManagedObject. Hyperlink Template: /api/space/job-management/jobs/{*ID}. |
id | Integer | Y | Y | N | MonitorableTaskInstanceManagedObject ID. |
name | String | Y | Y | N | MonitorableTaskInstanceManagedObject Name. |
scheduled-start-time-string | String | Y | Y | N | Scheduled Start Time String REST. |
schedule-string | String | Y | Y | N | Schedule String. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this deviceTargets node in the current node context. Hyperlink Template: /api/space/device-management/device-discovery-rules/{*ID}/device-targets. |
@total | Integer | Y | Y | N | Total number of gen_device-discovery-rules-device-discovery-rules-device-targets in the API result set. |
device-target | device-discovery-rules. | N | Y | Y * |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | N | Link to this deviceTarget node in the current node context. |
id | Integer | Y | Y | N | N | N | Id of device Target. |
device-ssh-credentials | device-discovery-rules. | N | Y | Y | N | N |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this deviceSshCredentials node in the current node context. Hyperlink Template: /api/space/device-management/device-discovery-rules/{*ID}/device-targets/device-ssh-credentials. |
@total | Integer | Y | Y | N | Total number of gen_device-discovery-rules-device-discovery-rules-device-discovery-rules-device-targets-device-targets-device-ssh-credentials in the API result set. |
device-ssh-credential | device-discovery-rules. | N | Y | Y * |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description | ||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | N | Link to this deviceSshCredential node in the current node context. |
||||||
id | Integer | Y | Y | N | N | N | Device credential id. |
||||||
username | String | N | Y | Y * | N | N | Name of user on the node used for authentication while discovery. |
||||||
keybased | Boolean | N | Y | Y * | N | N | True to enable key-based authentication. Default: false. |
||||||
credential-type | enum(credential-type) | N | Y | Y | N | N | Credential Type. Possible Values:
|
||||||
pass-phrase | String | N | Y | Y | N | N | Pass Phrase. |
||||||
private-key | String | N | Y | Y | N | N | Private Key. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this device-refs node in the current node context. |
@total | Integer | Y | Y | N | Total number of devices in the API result set. |
device | device-refs. | N | Y | Y * | Modeled device which contains details like device-name, platform, os-version, serial-number. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@href | String(URI) | N | Y | Y * | N | N | Link to an external device. Hyperlink Template: /api/space/device-management/devices/{*ID}. |
@uri | String(URI) | Y | Y | N | N | N | Link to this device node in the current node context. Hyperlink Template: /api/space/device-management/modeled-device-management/modeled-instances/{*ID}/devices. |
id | Integer | Y | Y | N | Y | Y | Id of the device. |
name | String | Y | Y | N | Y | Y | Name of the device. |
os-version | String | Y | Y | N | Y | Y | OS version of the device. |
platform | String | Y | Y | N | Y | Y | Platform of the device. |
serial-number | String | Y | Y | N | Y | Y | Serial Number of the device. |
status | String | Y | Y | N | Y | Y | Status of the device. |
managed-status | String | Y | Y | N | Y | Y | Managed status of the device. |
ip-addr | String | Y | Y | N | Y | Y | IP Address of the device. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | N | Y | Y * | Link to this devices node in the current node context. |
@size | Integer | N | Y | Y * |
Total number of devices. |
device | devices. | N | Y | Y |
A collection of devices. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description | ||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
@href | String(URI) | N | Y | Y * | N | N | Link to an external device. |
||||||||||||||||||||||||||||||||||||
@uri | String(URI) | N | Y | Y * | N | N | Link to this device node in the current node context. |
||||||||||||||||||||||||||||||||||||
@key | Integer | N | Y | Y * | Y | Y |
Unique identifier for the 'device'. |
||||||||||||||||||||||||||||||||||||
deviceFamily | String | N | Y | Y | Y | Y | Device family that the device belongs to (for example, MX) | ||||||||||||||||||||||||||||||||||||
OSVersion | String | N | Y | Y | N | N | OS version of the device | ||||||||||||||||||||||||||||||||||||
platform | String | N | Y | Y | Y | Y | Platform of the device | ||||||||||||||||||||||||||||||||||||
serialNumber | String | N | Y | Y | Y | Y | Serial number of the device | ||||||||||||||||||||||||||||||||||||
connectionStatus | String | N | Y | Y | Y | Y | Active connection status of the device | ||||||||||||||||||||||||||||||||||||
ipAddr | String | N | Y | Y | Y | Y | IP address of the device | ||||||||||||||||||||||||||||||||||||
managedStatus | String | N | Y | Y | Y | Y | Managed status of the device | ||||||||||||||||||||||||||||||||||||
device-id | int | N | Y | Y | N | N | Unique Identifier of Device | ||||||||||||||||||||||||||||||||||||
web-mgmt | String | N | Y | Y | N | N | Web management protocol | ||||||||||||||||||||||||||||||||||||
lsys-count | int | N | Y | Y | N | N | Device Lsys Count | ||||||||||||||||||||||||||||||||||||
rootLsys | DeviceDO | N | Y | Y | N | N | Device Lsys Root | ||||||||||||||||||||||||||||||||||||
hosting-deviceId | int | N | Y | Y | N | N | Hosting Device ID | ||||||||||||||||||||||||||||||||||||
authentication-status | enum(authentication-status) | N | Y | Y | N | N |
Authentication status of the Device
Possible Values:
|
||||||||||||||||||||||||||||||||||||
connection-type | String | N | Y | Y | N | N | Connection type of the Device | ||||||||||||||||||||||||||||||||||||
adapter-name | String | N | Y | Y | N | N | Name of the Adapter used for Device discovery | ||||||||||||||||||||||||||||||||||||
name | String | N | Y | Y | Y | Y | Name of the device | ||||||||||||||||||||||||||||||||||||
domain-id | Integer | N | Y | Y | N | Y |
domain id of device. |
||||||||||||||||||||||||||||||||||||
domain-name | String | N | Y | Y | N | N |
domain name of the device. |
||||||||||||||||||||||||||||||||||||
config-status | enum(config-status) | N | Y | Y | N | N |
Config Status
Possible Values:
|
||||||||||||||||||||||||||||||||||||
device-type | enum(device-type) | N | Y | Y | N | N | Device Type. Possible Values:
|
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | N | Y | Y * | Link to this devices node in the current node context. |
@size | Integer | N | Y | Y * |
Total number of devices. |
device | devices. | N | Y | Y |
A collection of devices. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description | ||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
@href | String(URI) | N | Y | Y * | N | N | Link to an external device. |
||||||||||||||||||||||||||||||||||||
@uri | String(URI) | N | Y | Y * | N | N | Link to this device node in the current node context. |
||||||||||||||||||||||||||||||||||||
@key | Integer | N | Y | Y * | Y | Y |
Unique identifier for the 'device'. |
||||||||||||||||||||||||||||||||||||
deviceFamily | String | N | Y | Y | Y | Y | Device family that the device belongs to (for example, MX) | ||||||||||||||||||||||||||||||||||||
OSVersion | String | N | Y | Y | N | N | OS version of the device | ||||||||||||||||||||||||||||||||||||
platform | String | N | Y | Y | Y | Y | Platform of the device | ||||||||||||||||||||||||||||||||||||
serialNumber | String | N | Y | Y | Y | Y | Serial number of the device | ||||||||||||||||||||||||||||||||||||
connectionStatus | String | N | Y | Y | Y | Y | Active connection status of the device | ||||||||||||||||||||||||||||||||||||
ipAddr | String | N | Y | Y | Y | Y | IP address of the device | ||||||||||||||||||||||||||||||||||||
managedStatus | String | N | Y | Y | Y | Y | Managed status of the device | ||||||||||||||||||||||||||||||||||||
device-id | int | N | Y | Y * | N | N | Unique Identifier of Device | ||||||||||||||||||||||||||||||||||||
web-mgmt | String | N | Y | Y | N | N | Web Management protocol | ||||||||||||||||||||||||||||||||||||
lsys-count | int | N | Y | Y * | N | N | Device Lsys Count | ||||||||||||||||||||||||||||||||||||
rootLsys | DeviceDO | N | Y | Y | N | N | Device Lsys Root | ||||||||||||||||||||||||||||||||||||
hosting-deviceId | int | N | Y | Y * | N | N | Hosting Device ID | ||||||||||||||||||||||||||||||||||||
authentication-status | enum(authentication-status) | N | Y | Y | N | N |
Authentication status of the Device
Possible Values:
|
||||||||||||||||||||||||||||||||||||
connection-type | String | N | Y | Y | N | N | Connection type of the Device | ||||||||||||||||||||||||||||||||||||
adapter-name | String | N | Y | Y | N | N | Name of the Adapter used for Device discovery | ||||||||||||||||||||||||||||||||||||
name | String | N | Y | Y | Y | Y | Name of the device | ||||||||||||||||||||||||||||||||||||
domain-id | Integer | N | Y | Y | N | Y |
domain id of device. |
||||||||||||||||||||||||||||||||||||
domain-name | String | N | Y | Y | N | N |
domain name of the device. |
||||||||||||||||||||||||||||||||||||
config-status | enum(config-status) | N | Y | Y | N | N |
Config Status
Possible Values:
|
||||||||||||||||||||||||||||||||||||
device-type | enum(device-type) | N | Y | Y | N | N | Device Type. Possible Values:
|
||||||||||||||||||||||||||||||||||||
attribute-column-0 | String | N | Y | Y | Y | Y | Custom Attribute for Device. |
||||||||||||||||||||||||||||||||||||
use-nat | boolean | N | Y | Y | Y | Y | An attribute that describes the device is connected to NAT or not. |
||||||||||||||||||||||||||||||||||||
fingerprint | String | N | Y | Y | N | N | |||||||||||||||||||||||||||||||||||||
newFingerprint | String | N | Y | Y | N | N |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this devices node in the current node context. |
@total | Integer | Y | Y | N | Total number of devices in the API result set. |
device | devices. | N | Y | Y * |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@href | String(URI) | N | Y | Y * | N | N | Link to an external device. Hyperlink Template: /api/space/device-management/devices/{*ID}. |
os-version | String | Y | Y | N | Y | Y | OS Version. |
device-name | String | Y | Y | N | Y | Y | Device Name. |
managed-status | String | Y | Y | N | Y | Y | Managed Status. |
platform | String | Y | Y | N | Y | Y | Platform. |
domain-id | Integer | Y | Y | N | N | Y | Domain ID. |
id | Integer | Y | Y | N | Y | Y | Device ID. |
name | String | Y | Y | N | Y | Y | Device Name. |
ip-address | String | Y | Y | N | Y | Y | IP Address. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this devices-by-templates2 node in the current node context. |
@total | Integer | Y | Y | N | Total number of devices-by-templates2 in the API result set. |
device-template | devices-by-templates2. | N | Y | Y * |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description | ||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | N | Link to this deviceTemplate node in the current node context. |
||||||||||||||||||||||||||||||||||||
attribute-column0 | String | N | Y | Y * | Y | Y | Attribute Column0. |
||||||||||||||||||||||||||||||||||||
software-release | String | N | Y | Y * | Y | Y | Software Release. |
||||||||||||||||||||||||||||||||||||
OSVersion | String | N | Y | Y | Y | Y | OS Version. |
||||||||||||||||||||||||||||||||||||
connectionStatus | String | N | Y | Y | Y | Y | Connection Status. |
||||||||||||||||||||||||||||||||||||
ipAddr | String | N | Y | Y | Y | Y | IP Addr. |
||||||||||||||||||||||||||||||||||||
platform | String | N | Y | Y * | Y | Y | Platform. |
||||||||||||||||||||||||||||||||||||
original-platform | String | N | Y | Y * | N | N | Original Platform. |
||||||||||||||||||||||||||||||||||||
status | String | N | Y | Y * | Y | Y | Status. |
||||||||||||||||||||||||||||||||||||
templateVer | Integer | N | Y | Y * | N | N | Template Ver. |
||||||||||||||||||||||||||||||||||||
managedStatus | String | N | Y | Y | Y | Y | Managed Status. |
||||||||||||||||||||||||||||||||||||
id | Integer | Y | Y | N | Y | Y | DeviceTemplate ID. |
||||||||||||||||||||||||||||||||||||
name | String | N | Y | Y * | Y | Y | DeviceTemplate Name. |
||||||||||||||||||||||||||||||||||||
config-status | enum(config-status) | N | Y | Y * | N | N | Config Status. Possible Values:
|
||||||||||||||||||||||||||||||||||||
device-family | String | N | Y | Y * | Y | Y | Device Family. |
||||||||||||||||||||||||||||||||||||
domain-name | String | N | Y | Y | N | N | Domain Name. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
value | String | N | Y | Y * | Value. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
users | disable-users-request. | N | Y | Y * |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this users node in the current node context. |
user | disable-users-request. | N | Y | Y * | Get all users. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@href | String(URI) | N | Y | Y * | N | N | Link to an external user. Hyperlink Template: /api/space/user-management/users/{*ID}. |
id | Integer | Y | Y | N | Y | Y | User ID. |
name | String | Y | Y | N | Y | Y | User Name. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
discoveryMethods | DiscoveryTarget[] | N | Y | Y | Discovery target schemes |
usePing | Boolean | N | Y | Y | A flag for using ping |
useSnmp | Boolean | N | Y | Y | A flag for using SNMP |
snmpSettings | SnmpSetting[] | N | Y | Y | SNMP setting schemes |
manageDiscoveredSystemsFlag | Boolean | N | Y | Y | A flag to manage the discovery system |
credentials | Credential[] | N | Y | Y |
List of credentials for testing the connectivity of the discovered system. |
device-fingerprints | DeviceFingerprints | N | Y | Y |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
device-discovery-rules | discover-devices-request. | N | Y | Y * |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this deviceTargetRules node in the current node context. |
device-discovery-rule | discover-devices-request. | N | Y | Y * |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@href | String(URI) | N | Y | Y * | N | N | Link to an external device-discovery-rule. Hyperlink Template: /api/space/device-management/device-discovery-rules/{*ID}. |
id | Integer | Y | Y | N | Y | Y | DeviceDiscoveryRule ID. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this discovery-job-results node in the current node context. |
@total | Integer | Y | Y | N | Total number of discovery-job-results in the API result set. |
system-discovery-result | discovery-job-results. | N | Y | Y * |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | N | Link to this systemDiscoveryResult node in the current node context. |
||||||||||||||||
id | Integer | Y | Y | N | N | N | Job result table row ID. |
||||||||||||||||
discovery-fail-reason | String | N | Y | Y * | Y | Y | If the system fails to be discovered or managed by JMP, set the fail reason. |
||||||||||||||||
vendor-name | String | N | Y | Y * | Y | N | Vendor Name. |
||||||||||||||||
system-discovery-status | enum(system-discovery-status) | N | Y | Y * | Y | Y | System discovery status. Possible Values:
|
||||||||||||||||
hostname | String | N | Y | Y | Y | Y | Hostname. |
||||||||||||||||
device-id | Integer | N | Y | Y | Y | Y | Device Id. |
||||||||||||||||
serial-num | String | N | Y | Y | N | N | Serial Num. |
||||||||||||||||
ip | String | N | Y | Y * | Y | Y | Scanned ip. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@size | Integer | N | Y | Y * |
Total number of results. |
discoveryresult | SystemDiscoveryResult[] | N | Y | Y * |
A collection of results. |
Field Name | Type | Read Only | GET | PUT / POST | Description | ||||||
---|---|---|---|---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this domain node in the current node context. Hyperlink Template: /api/space/domain-management/domains/{*ID}. |
||||||
@href | String(URI) | Y | Y | N | Link to an external domain. Hyperlink Template: /api/space/domain-management/domains/{*ID}. |
||||||
write-enabled | Boolean | Y | Y | N | If true then user has read and write access to the domain else user has either read only or no access. Default: false. |
||||||
*id | Integer | Y | Y | N | ID of domain. |
||||||
child-count | Integer | Y | Y | N | The number of immediate children for this domain. |
||||||
modified-at | String | Y | Y | N | The time this domain was last modified at. |
||||||
created-at | String | Y | Y | N | Time the domain was created. |
||||||
description | String | N | Y | Y | Description added by user. |
||||||
parent | domain. | N | Y | Y | The parent domain of this domain. |
||||||
name | String | N | Y | Y * | Name of the domain. |
||||||
children | domain. | Y | Y | N | List of sub domain of the domain. |
||||||
child-lock | Boolean | N | Y | Y * | If set to true the domain does not allow read and execute access to it's parent domain objects. Default: false. |
||||||
domain-type | enum(domain-type) | N | Y | Y | Domain Type. Possible Values:
Default: CUSTOM. |
||||||
no-of-assigned-devices | Integer | N | Y | Y | No Of Assigned Devices. |
||||||
no-of-assigned-users | Integer | N | Y | Y | No Of Assigned Users. |
||||||
no-of-assigned-remote-profile | Integer | N | Y | Y | No Of Assigned Remote Profile. |
||||||
users | String | Y | Y | N | List of users assigned to the domain Hyperlink Template: /api/space/domain-management/domains/{*ID}/users. |
||||||
profiles | String | Y | Y | N | List of remote profiles assigned to the domain Hyperlink Template: /api/space/domain-management/domains/{*ID}/profiles. |
||||||
devices | String | Y | Y | N | Assign Devices to the Domain Hyperlink Template: /api/space/domain-management/domains/{*ID}/devices. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this domain node in the current node context. Hyperlink Template: /api/space/domain-management/domains/{*ID}. |
@href | String(URI) | N | Y | Y * | Link to an external domain_REF. Hyperlink Template: /api/space/domain-management/domains/{*ID}. |
id | Integer | Y | Y | N | ID of domain. |
name | String | N | Y | Y | Name of the domain. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this domains node in the current node context. Hyperlink Template: /api/space/domain-management/domains/{*ID}/children. |
domain | domain. | N | Y | Y * |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description | ||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
@href | String(URI) | N | Y | Y * | N | N | Link to an external domain_REF. Hyperlink Template: /api/space/domain-management/domains/{*ID}. |
||||||
@uri | String(URI) | Y | Y | N | N | N | Link to this domain node in the current node context. Hyperlink Template: /api/space/domain-management/domains/{*ID}/children/{*ID}. |
||||||
id | Integer | Y | Y | N | N | N | ID of domain. |
||||||
name | String | Y | Y | N | N | N | Name of the domain. |
||||||
child-count | Integer | Y | Y | N | N | N | The number of immediate children for this domain. |
||||||
created-at | String | Y | Y | N | N | N | Time the domain was created. |
||||||
description | String | Y | Y | N | Y | N | Description added by user. |
||||||
write-enabled | Boolean | Y | Y | N | N | N | If true then user has read and write access to the domain else user has either read only or no access. Default: false. |
||||||
child-lock | Boolean | Y | Y | N | N | N | If set to true the domain does not allow read and execute access to it's parent domain objects. Default: false. |
||||||
domain-type | enum(domain-type) | N | Y | Y | N | N | Domain Type. Possible Values:
Default: CUSTOM. |
||||||
no-of-assigned-devices | Integer | Y | Y | N | N | N | No Of Assigned Devices. |
||||||
no-of-assigned-users | Integer | Y | Y | N | N | N | No Of Assigned Users. |
||||||
no-of-assigned-remote-profile | Integer | Y | Y | N | N | N | No Of Assigned Remote Profile. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this domain-children node in the current node context. Hyperlink Template: /api/space/domain-management/domains/{*ID}/children/{*ID}. |
@href | String(URI) | Y | Y | N | Link to an external domain-children. Hyperlink Template: /api/space/domain-management/domains/{*ID}. |
*id | Integer | N | Y | Y * | ID of domain. |
name | String | N | Y | Y * | Name of the domain. |
description | String | N | Y | Y * | Description added by user. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this domains node in the current node context. |
@total | Integer | Y | Y | N | Total number of domains in the API result set. |
domain | domains. | N | Y | Y * |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description | ||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
@href | String(URI) | N | Y | Y | N | N | Link to an external domain. Hyperlink Template: /api/space/domain-management/domains/{*ID}. |
||||||
@uri | String(URI) | Y | Y | N | N | N | Link to this domain node in the current node context. Hyperlink Template: /api/space/domain-management/domains/{*ID}. |
||||||
id | Integer | Y | Y | N | N | N | ID of domain. |
||||||
created-at | String | Y | Y | N | N | N | Time the domain was created. |
||||||
modified-at | String | Y | Y | N | N | N | Time the domain was last modified. |
||||||
description | String | N | Y | Y | N | N | Description added by user. |
||||||
name | String | N | Y | Y * | N | N | Name of the domain. |
||||||
children | domains. | Y | Y | N | N | N | List of sub domain of the domain. |
||||||
child-lock | Boolean | N | Y | Y * | N | N | Default: false. |
||||||
domain-type | enum(domain-type) | N | Y | Y | N | N | Domain Type. Possible Values:
Default: CUSTOM. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this domains node in the current node context. Hyperlink Template: /api/space/domain-management/domains/{*ID}/children. |
domain | domains. | N | Y | Y * |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | N | Link to this domain node in the current node context. Hyperlink Template: /api/space/domain-management/domains/{*ID}/children/{*ID}. |
@href | String(URI) | N | Y | Y | N | N | Link to an external domain_REF. Hyperlink Template: /api/space/domain-management/domains/{*ID}. |
id | Integer | Y | Y | N | N | N | ID of domain. |
name | String | N | Y | Y * | N | N | Name of the domain. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this domains node in the current node context. |
@total | Integer | Y | Y | N | Total number of domains in the API result set. |
domain | domains. | N | Y | Y * |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description | ||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | N | Link to this domain node in the current node context. Hyperlink Template: /api/space/domain-management/domains/{*ID}. |
||||||
@href | String(URI) | Y | Y | N | N | N | Link to an external domain. Hyperlink Template: /api/space/domain-management/domains/{*ID}. |
||||||
id | Integer | Y | Y | N | N | N | Domain ID. |
||||||
name | String | Y | Y | N | Y | Y | Domain Name. |
||||||
children | domains. | Y | Y | N | N | N | |||||||
child-count | Integer | Y | Y | N | N | N | Child Count. |
||||||
child-lock | Boolean | Y | Y | N | N | N | Child Lock. Default: false. |
||||||
domain-type | enum(domain-type) | N | Y | Y | N | N | Domain Type. Possible Values:
Default: CUSTOM. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this domains node in the current node context. Hyperlink Template: /api/space/domain-management/domains/{*ID}/children. |
@total | Integer | Y | Y | N | Total number of gen_domains-domains-children in the API result set. |
domain | domains. | N | Y | Y * |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | N | Link to this domain node in the current node context. Hyperlink Template: /api/space/domain-management/domains/{*ID}/children/{*ID}. |
@href | String(URI) | Y | Y | N | N | N | Link to an external domain_REF. Hyperlink Template: /api/space/domain-management/domains/{*ID}. |
child-count | Integer | Y | Y | N | N | N | Child Count. |
id | Integer | Y | Y | N | N | N | Domain ID. |
name | String | Y | Y | N | Y | N | Domain Name. |
child-lock | Boolean | Y | Y | N | N | N | Child Lock. Default: false. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
value | String | N | Y | Y * | Value. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
users | enable-users-request. | N | Y | Y * |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this users node in the current node context. |
user | enable-users-request. | N | Y | Y * | Get all users. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@href | String(URI) | N | Y | Y * | N | N | Link to an external user. Hyperlink Template: /api/space/user-management/users/{*ID}. |
id | Integer | Y | Y | N | Y | Y | User ID. |
name | String | Y | Y | N | Y | Y | User Name. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@uri | String(URI) | N | Y | Y | N | N | Link to this equipment-holder node in the current node context. |
id | Integer | N | Y | Y * | N | N | The ID of the equipment holder |
name | String | N | Y | Y | N | N | The name of the holder |
path | String | N | Y | Y | N | N | The location of the element in the managed element |
alias | String | N | Y | Y | N | N | An alias for the equipment holder |
containedEquipment | equipment-holder[] | N | Y | Y | N | N | The equipment and equipment holders directly contained by this holder |
holderType | String | N | Y | Y | N | N | The current type of the equipment holder with respect to the contained equipment |
holderState | String | N | Y | Y | N | N | The current condition of the equipment holder with respect to the contained equipment |
expectedOrInstalledEquipment | JSEquipment | N | Y | Y | N | N | The equipment that is installed or is expected to be installed in the physical container represented by the equipment holder |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@uri | String(URI) | N | Y | Y | N | N | Link to this equipment-holder node in the current node context. |
id | Integer | N | Y | Y * | N | N | The ID of the equipment holder |
name | String | N | Y | Y | N | N | The name of equipment holder |
path | String | N | Y | Y | N | N | The location of the equipment holder in the managed element |
alias | String | N | Y | Y | N | N | An alias for the equipment holder |
containedEquipment | equipment-holder[] | N | Y | Y | N | N | The equipment and equipment holders directly contained by this holder |
holderType | String | N | Y | Y | N | N | The current type of the equipment holder with respect to the contained equipment |
holderState | String | N | Y | Y | N | N | The current condition of the equipment holder with respect to the contained equipment |
expectedOrInstalledEquipment | JSEquipment | N | Y | Y | N | N | The equipment that is installed or is expected to be installed in the physical container represented by the equipment holder |
Field Name | Type | Read Only | GET | PUT / POST | Description | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this equipment-holder node in the current node context. Hyperlink Template: /api/space/managed-domain/equipment-holders/{*ID}. |
||||||||||||||||||
@href | String(URI) | Y | Y | N | Link to an external equipment-holder. Hyperlink Template: /api/space/managed-domain/equipment-holders/{*ID}. |
||||||||||||||||||
child-count | Integer | N | Y | Y * | Number of Child Equipment holder. |
||||||||||||||||||
hosting-me | equipment-holder. | N | Y | Y | |||||||||||||||||||
expected-or-installed-equipment | equipment-holder. | N | Y | Y * | |||||||||||||||||||
holder-type | enum(holder-type) | N | Y | Y * | This attribute identifies the type of the Holder (Rack (or Bay), Shelf, Sub-shelf, Slot,
Subslot, Remote-unit or Remote-subslot). Possible Values:
|
||||||||||||||||||
contained-equipment | equipment-holder. | N | Y | Y * | |||||||||||||||||||
*id | Integer | Y | Y | N | Object Id. |
||||||||||||||||||
device-name | String | N | Y | Y * | Device Name. |
||||||||||||||||||
domain-id | Integer | N | Y | Y | Domain ID. |
||||||||||||||||||
name | String | N | Y | Y * | EquipmentHolder Name. |
||||||||||||||||||
path | String | N | Y | Y * | Path. |
||||||||||||||||||
device-id | Integer | N | Y | Y * | Device ID. |
||||||||||||||||||
belong-to | equipment-holder. | N | Y | Y | |||||||||||||||||||
domain-name | String | Y | Y | N | Domain Name. |
||||||||||||||||||
holder-state | enum(holder-state) | N | Y | Y * | This attribute identifies the state of the Holder (Empty, Installed&Expected,
Expected&NotInstalled, Installed&NotExpected, Mismatch, Unavailable or Unknown). Possible Values:
|
||||||||||||||||||
belong-to-id | Integer | N | Y | Y * | Belong To ID. |
||||||||||||||||||
display-name | String | N | Y | Y | Display Name. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@href | String(URI) | N | Y | Y * | Link to an external managedElement. Hyperlink Template: /api/space/managed-domain/managed-elements/{*ID}. |
id | Integer | Y | Y | N | Object Id. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this equipment node in the current node context. |
installed-equipment-object-type | String | Y | Y | N | This attribute identifies the type of the installed resource. |
expected-equipment-object-type | String | Y | Y | N | This attribute identifies the type of the expected resource. |
installed-serial-number | String | Y | Y | N | This is the serial number of the installed equipment. |
installed-description | String | Y | Y | N | This attribute gives a description of the installed equipment, if not available empty string
shall be used. |
domain-name | String | Y | Y | N | Domain Name. |
manufacturer | String | Y | Y | N | The manufacturer attribute identifies the equipment manufacturer name. |
installed-vendor-part-number | String | Y | Y | N | Installed Vendor Part Number. |
display-name | String | Y | Y | N | Display Name. |
id | String | Y | Y | N | MOID. |
installed-version | String | Y | Y | N | This attribute identifies the resource version of the installed equipment, if not available
empty string shall be used. |
installed-model | String | Y | Y | N | Installed Model. |
domain-id | Integer | Y | Y | N | Domain ID. |
name | String | Y | Y | N | Equipment Name. |
device-id | Integer | Y | Y | N | Device ID. |
installed-part-number | String | Y | Y | N | This attribute identifies the resource Part Number (PN) of the installed equipment. |
installed-vendor-material-number | String | Y | Y | N | Installed Vendor Material Number. |
path | String | Y | Y | N | Path. |
comp-status | String | Y | Y | N | Comp Status. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this equipmentHolders node in the current node context. Hyperlink Template: /api/space/managed-domain/equipment-holders/{*ID}/contained-equipment. |
@total | Integer | Y | Y | N | Total number of gen_equipment-holder-contained-equipment in the API result set. |
equipment-holder | equipment-holder. | N | Y | Y * |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@href | String(URI) | N | Y | Y * | N | N | Link to an external equipmentHolder_REF. Hyperlink Template: /api/space/managed-domain/equipment-holders/{*ID}. |
id | Integer | Y | Y | N | N | N | Object Id. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@href | String(URI) | N | Y | Y | Link to an external equipmentHolder_REF. Hyperlink Template: /api/space/managed-domain/equipment-holders/{*ID}. |
id | Integer | Y | Y | N | Object Id. |
name | String | Y | Y | N | EquipmentHolder Name. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | N | Y | Y | Link to this equipment-holders node in the current node context. |
@size | Integer | N | Y | Y | The URI for the collection of all equipment holders for a managed element |
equipment-holder | equipment-holders. | N | Y | Y | The manageable physical components of the network equipment such as the circuit packs, the fans, and any other type of replaceable unit within the network equipment |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@key | Integer | N | Y | Y * | N | N | The ID of equipment holder |
@uri | String(URI) | N | Y | Y | N | N | Link to this equipmentHolderDTO node in the current node context. |
id | Integer | N | Y | Y * | N | N | The ID of the managed element |
name | String | N | Y | Y | N | N | The name of the equipment holder |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this equipment-holders node in the current node context. |
@total | Integer | Y | Y | N | Total number of equipment-holders in the API result set. |
equipment-holder | equipment-holders. | N | Y | Y * |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | N | Link to this equipmentHolder node in the current node context. Hyperlink Template: /api/space/managed-domain/equipment-holders/{*ID}. |
||||||||||||||||||
@href | String(URI) | Y | Y | N | N | N | Link to an external equipmentHolder. Hyperlink Template: /api/space/managed-domain/equipment-holders/{*ID}. |
||||||||||||||||||
child-count | Integer | N | Y | Y * | N | N | Number of Child Equipment holder. |
||||||||||||||||||
hosting-me | equipment-holders. | N | Y | Y | N | N | |||||||||||||||||||
expected-or-installed-equipment | equipment-holders. | N | Y | Y * | N | N | |||||||||||||||||||
holder-type | enum(holder-type) | N | Y | Y * | N | N | This attribute identifies the type of the Holder (Rack (or Bay), Shelf, Sub-shelf, Slot,
Subslot, Remote-unit or Remote-subslot). Possible Values:
|
||||||||||||||||||
id | Integer | Y | Y | N | N | Y | Object Id. |
||||||||||||||||||
belong-to-id | Integer | N | Y | Y * | N | N | Belong To ID. |
||||||||||||||||||
device-name | String | N | Y | Y * | N | N | Device Name. |
||||||||||||||||||
domain-id | Integer | N | Y | Y | N | Y | Domain ID. |
||||||||||||||||||
name | String | N | Y | Y * | N | N | EquipmentHolder Name. |
||||||||||||||||||
path | String | N | Y | Y * | N | N | Path. |
||||||||||||||||||
device-id | Integer | N | Y | Y * | N | Y | Device ID. |
||||||||||||||||||
belong-to | equipment-holders. | N | Y | Y | N | N | |||||||||||||||||||
domain-name | String | Y | Y | N | N | N | Domain Name. |
||||||||||||||||||
holder-state | enum(holder-state) | N | Y | Y * | N | N | This attribute identifies the state of the Holder (Empty, Installed&Expected,
Expected&NotInstalled, Installed&NotExpected, Mismatch, Unavailable or Unknown). Possible Values:
|
||||||||||||||||||
display-name | String | N | Y | Y | N | N | Display Name. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@href | String(URI) | N | Y | Y * | Link to an external managedElement. Hyperlink Template: /api/space/managed-domain/managed-elements/{*ID}. |
id | Integer | Y | Y | N | Object Id. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this equipment node in the current node context. |
installed-equipment-object-type | String | Y | Y | N | This attribute identifies the type of the installed resource. |
expected-equipment-object-type | String | Y | Y | N | This attribute identifies the type of the expected resource. |
installed-serial-number | String | Y | Y | N | This is the serial number of the installed equipment. |
installed-description | String | Y | Y | N | This attribute gives a description of the installed equipment, if not available empty string
shall be used. |
domain-name | String | Y | Y | N | Domain Name. |
installed-vendor-part-number | String | Y | Y | N | Installed Vendor Part Number. |
installed-version | String | Y | Y | N | This attribute identifies the resource version of the installed equipment, if not available
empty string shall be used. |
installed-model | String | Y | Y | N | Installed Model. |
domain-id | Integer | Y | Y | N | Domain ID. |
name | String | Y | Y | N | Equipment Name. |
device-id | Integer | Y | Y | N | Device ID. |
installed-part-number | String | Y | Y | N | This attribute identifies the resource Part Number (PN) of the installed equipment. |
installed-vendor-material-number | String | Y | Y | N | Installed Vendor Material Number. |
path | String | Y | Y | N | Path. |
comp-status | String | Y | Y | N | Comp Status. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@href | String(URI) | N | Y | Y * | Link to an external equipmentHolder_REF. Hyperlink Template: /api/space/managed-domain/equipment-holders/{*ID}. |
id | Integer | Y | Y | N | Object Id. |
name | String | Y | Y | N | EquipmentHolder Name. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | N | Y | Y | Link to this exec-backup node in the current node context. |
devices | exec-backup. | N | Y | Y | List of devices to back up. |
scpProperty | exec-backup. | N | Y | Y | SCP Property to backup Device Configuration Files. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@size | Integer | N | Y | Y | Total number of devices or configuration files to be backed up (or were backed up). |
@uri | String(URI) | N | Y | Y | Link to this configFileMOs node in the current node context. |
device | exec-backup. | N | Y | Y | Collection of devices or configuration files to back up. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@uri | String(URI) | N | Y | Y | N | N | Link to this configFileMO node in the current node context. |
@href | String(URI) | N | Y | Y | N | N | Link to an external configFileMO. |
deviceId | int | N | Y | Y | N | N | Device ID. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
ipAddress | String | N | Y | Y | Initialize Remote server address. |
port | int | N | Y | Y * | Initialize Remote server Port. |
fingerprint | String | N | Y | Y | Initialize Remote server Fingerprint. |
directory | String | N | Y | Y | Initialize Remote server path, which is used for where the configuration file going to placed. |
user-name | String | N | Y | Y | Initialize remote server auth userName. |
password | String | N | Y | Y | Initialize remote server password. |
credentialType | String | N | Y | Y | credentialType {CREDENTIAL_BASED (or) KEY_BASED (or) CUSTOM_KEY_BASED}. |
passPhrase | String | N | Y | Y | passPhrase. |
privateKey | String | N | Y | Y | privateKey. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this exec-commands node in the current node context. |
@total | Integer | Y | Y | N | Total number of exec-commands-results in the API result set. |
exec-command-result | exec-commands. | N | Y | Y * |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description | ||||
---|---|---|---|---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | N | Link to this execCommandResult node in the current node context. |
||||
error-message | String | N | Y | Y | N | N | Error Message. |
||||
status | enum(status) | N | Y | Y * | N | N | Status. Possible Values:
|
||||
replies | exec-commands. | N | Y | Y | N | N |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this replies node in the current node context. |
@total | Integer | Y | Y | N | Total number of gen_exec-commands-results-exec-commands-replies in the API result set. |
reply | exec-commands. | N | Y | Y * |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | N | Link to this execCommandReply node in the current node context. |
content | String | N | Y | Y * | N | N | Content. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
device-id | Integer | N | Y | Y * | Device ID. |
commands | exec-commands-request. | N | Y | Y * |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this commands node in the current node context. |
command | String[] | N | Y | Y * | Commands. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | N | Y | Y | Link to this exec-deploy node in the current node context. |
devices | exec-deploy. | N | Y | Y * |
Devices on which the software package is to be deployed. |
deployOptions | exec-deploy. | N | Y | Y |
Type 'installOptions' specifies the different deployment options for the software package. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
device | exec-deploy. | N | Y | Y * |
A collection of devices on which the software package is to be deployed. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@key | Integer | N | Y | Y | N | N | A unique identifier for the device |
@href | String(URI) | N | Y | Y | N | N | Link to an external device. |
@uri | String(URI) | N | Y | Y | N | N | Link to this device node in the current node context. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
useAlreadyDownloaded | Boolean | N | Y | Y |
A condition specifying whether or not to use an already downloaded package. |
snapShotRequired | Boolean | N | Y | Y |
A condition specifying whether or not a snapshot is required. |
validate | Boolean | N | Y | Y |
A condition specifying whether or not to validate the software package. |
bestEffortLoad | Boolean | N | Y | Y | A condition specifying whether the best effort load is required |
removePkgAfterInstallation | Boolean | N | Y | Y |
A condition specifying whether or not to remove package after installation. |
rebootDevice | Boolean | N | Y | Y |
A condition specifying whether or not to reboot the device after the software package is deployed. |
rebootAfterXMinutes | Integer | N | Y | Y | The time in minutes after which the device should reboot |
upgradePrimaryPartition | Boolean | N | Y | Y | The condition whether backup primary partition |
cleanUpExistingOnDevice | Boolean | N | Y | Y | The condition specifying whether the existing software package on the device should be cleaned up |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
scriptMgmt | exec-deploy. | N | Y | Y * | The set of inputs for the operation |
scriptEnable | boolean | N | Y | Y |
A flag that indicates whether a script or scripts are enabled while staging
the script on a device. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
script | exec-deploy. | N | Y | Y * | N | N | A unique identifier for the script |
scriptVersionSelected | Float | N | Y | Y | N | N | The version of the scrip |
device | exec-deploy. | N | Y | Y * | N | N | The device type on which the operation is to be performed |
scriptParam | exec-deploy. | N | Y | Y | N | N | The list of parameters needed by the script |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
paramName | String | N | Y | Y * | N | N | The parameter name |
paramValue | String | N | Y | Y * | N | N | The parameter value |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@href | String(URI) | N | Y | Y | Link to an external device. |
@uri | String(URI) | N | Y | Y | Link to this device node in the current node context. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@href | String(URI) | N | Y | Y | Link to an external script. |
@uri | String(URI) | N | Y | Y | Link to this script node in the current node context. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this exec-deploy-jam-request node in the current node context. |
devices | exec-deploy-jam-request. | N | Y | Y * | Devices on which the JAM Package is to be deployed. |
deployOptions | exec-deploy-jam-request. | N | Y | Y | Type 'deployOptions' specifies the different Deployment Option(s) ( i. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this devices node in the current node context. Hyperlink Template: /devices. |
device | exec-deploy-jam-request. | N | Y | Y * | A collection of Devices on which the JAM Package is to be deployed. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@href | String(URI) | N | Y | Y * | N | N | Link to an external device. Hyperlink Template: /api/space/device-management/devices/{*ID}. |
id | Integer | Y | Y | N | Y | Y | ID of the Device on which the JAM package is to be deployed. |
name | String | Y | Y | N | Y | Y | Name of the on which the JAM package is to be deployed. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this deviceImageInstallOptions node in the current node context. |
use-already-downloaded-jam | Boolean | N | Y | Y | A condition specifying whether or not to use an already downloaded JAM Package in the Device. Default: false. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
script-deploy-profiles | exec-deploy-multiple-support. | N | Y | Y * | Contains multiple execution set. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this scriptDeployLists node in the current node context. |
script-deploy-profile | exec-deploy-multiple-support. | N | Y | Y * | Describes an execution set of scripts and devices. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | N | Link to this scriptDeploy node in the current node context. |
script-details | exec-deploy-multiple-support. | N | Y | Y * | N | N | Collection of details of multiple scripts. |
devices | exec-deploy-multiple-support. | N | Y | Y * | N | N | Device details list. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this scriptdetails node in the current node context. Hyperlink Template: /scriptdetails. |
@total | Integer | Y | Y | N | Total number of gen_run-deploy-scripts-on-devices_v3-request-script-deploy-lists-script-deploy-lists-scriptdetails in the API result set. |
script-detail | exec-deploy-multiple-support. | N | Y | Y * | Details about a single script. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | N | Link to this deployScript node in the current node context. |
script | exec-deploy-multiple-support. | N | Y | Y * | N | N | |
script-enable | Boolean | N | Y | Y * | N | N | Script Enable. Default: true. |
script-version-selected | String | N | Y | Y * | N | N | Script Version Selected. |
script-params | exec-deploy-multiple-support. | N | Y | Y | N | N | Parameters for the script. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this script node in the current node context. Hyperlink Template: /scriptdetails. |
@href | String(URI) | N | Y | Y * | Link to an external script. Hyperlink Template: /api/space/script-management/scripts/{*ID}. |
id | Integer | Y | Y | N | Script ID. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this scriptParams node in the current node context. Hyperlink Template: /scriptdetails/script-params. |
@total | Integer | Y | Y | N | Total number of gen_deploy-multilple-scripts-on-devices-run-deploy-scripts-on-devices_v3-request-script-deploy-lists-script-deploy-lists-run-deploy-scripts-on-devices_v3-request-script-deploy-lists-script-deploy-lists-scriptdetails-scriptdetails-script-params in the API result set. |
script-params-gui | exec-deploy-multiple-support. | N | Y | Y |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | N | Link to this scriptParamsGUI node in the current node context. |
param-value | String | N | Y | Y * | N | N | Param Value. |
param-name | String | N | Y | Y * | N | N | Param Name. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this deviceIDs node in the current node context. |
@total | Integer | Y | Y | N | Total number of gen_run-deploy-scripts-on-devices_v3-request-script-deploy-lists-script-deploy-lists-device-ids in the API result set. |
device | exec-deploy-multiple-support. | N | Y | Y * |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | N | Link to this device node in the current node context. |
@href | String(URI) | N | Y | Y * | N | N | Link to an external device. Hyperlink Template: /api/space/device-management/devices/{*ID}. |
id | Integer | Y | Y | N | Y | Y | Device ID. |
name | String | Y | Y | N | Y | Y | Device Name. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
script-deploy-profiles | exec-deploy-request. | N | Y | Y * | Contains multiple execution set. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this scriptDeployLists node in the current node context. |
script-deploy-profile | exec-deploy-request. | N | Y | Y * | Describes an execution set of scripts and devices. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | N | Link to this scriptDeploy node in the current node context. |
script-details | exec-deploy-request. | N | Y | Y * | N | N | Collection of details of multiple scripts. |
devices | exec-deploy-request. | N | Y | Y * | N | N | Device details list. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this scriptdetails node in the current node context. Hyperlink Template: /scriptdetails. |
@total | Integer | Y | Y | N | Total number of gen_run-deploy-scripts-on-devices_v3-request-script-deploy-lists-script-deploy-lists-scriptdetails in the API result set. |
script-detail | exec-deploy-request. | N | Y | Y * | Details about a single script. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | N | Link to this deployScript node in the current node context. |
script | exec-deploy-request. | N | Y | Y * | N | N | |
script-enable | Boolean | N | Y | Y * | N | N | Script Enable. Default: true. |
script-version-selected | String | N | Y | Y * | N | N | Script Version Selected. |
script-params | exec-deploy-request. | N | Y | Y | N | N | Parameters for the script. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this script node in the current node context. Hyperlink Template: /scriptdetails. |
@href | String(URI) | N | Y | Y * | Link to an external script. Hyperlink Template: /api/space/script-management/scripts/{*ID}. |
id | Integer | Y | Y | N | Script ID. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this scriptParams node in the current node context. Hyperlink Template: /scriptdetails/script-params. |
@total | Integer | Y | Y | N | Total number of gen_deploy-multilple-scripts-on-devices-run-deploy-scripts-on-devices_v3-request-script-deploy-lists-script-deploy-lists-run-deploy-scripts-on-devices_v3-request-script-deploy-lists-script-deploy-lists-scriptdetails-scriptdetails-script-params in the API result set. |
script-params-gui | exec-deploy-request. | N | Y | Y |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | N | Link to this scriptParamsGUI node in the current node context. |
param-value | String | N | Y | Y * | N | N | Param Value. |
param-name | String | N | Y | Y * | N | N | Param Name. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this deviceIDs node in the current node context. |
@total | Integer | Y | Y | N | Total number of gen_run-deploy-scripts-on-devices_v3-request-script-deploy-lists-script-deploy-lists-device-ids in the API result set. |
device | exec-deploy-request. | N | Y | Y * |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | N | Link to this device node in the current node context. |
@href | String(URI) | N | Y | Y * | N | N | Link to an external device. Hyperlink Template: /api/space/device-management/devices/{*ID}. |
id | Integer | Y | Y | N | Y | Y | Device ID. |
name | String | Y | Y | N | Y | Y | Device Name. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
devices | exec-deploy-request. | N | Y | Y * | The list of devices for deployment of the configuration template. |
resolved-variables | exec-deploy-request. | N | Y | Y * | A list of resolved variables based on the device. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this deviceLists node in the current node context. |
device | exec-deploy-request. | N | Y | Y * | The device to which to deploy the configuration template. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | N | Link to this device node in the current node context. |
@href | String(URI) | N | Y | Y * | N | N | Link to an external device. Hyperlink Template: /api/space/device-management/devices/{*ID}. |
id | Integer | Y | Y | N | Y | Y | |
name | String | Y | Y | N | Y | Y | Device Name. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this resolvedVariables node in the current node context. |
device | exec-deploy-request. | N | Y | Y * | The list of resolved variables per device. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | N | Link to this resolvedVariablesPerDevice node in the current node context. |
device-id | Integer | N | Y | Y * | N | N | The ID of the device with the resolved variables. |
variables | exec-deploy-request. | N | Y | Y * | N | N | The list of resolved variables on the device. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this variables node in the current node context. Hyperlink Template: /variables. |
@total | Integer | Y | Y | N | Total number of gen_exec-deploy-request-resolved-variables-resolved-variables-variables in the API result set. |
variable | exec-deploy-request. | N | Y | Y * | The resolved variable on the device. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | N | Link to this resolvedSingleVariable node in the current node context. |
values | exec-deploy-request. | N | Y | Y * | N | N | The list of values for the resolved variable. |
name | String | N | Y | Y * | N | N | The name of the variable. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this values node in the current node context. |
@total | Integer | Y | Y | N | Total number of gen_exec-deploy-request-resolved-variables-resolved-variables-variables-variables-values in the API result set. |
value | String[] | N | Y | Y * | The value of the variable. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
scriptMgmt | exec-disable. | N | Y | Y * | The set of inputs for the operation |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
script | exec-disable. | N | Y | Y * | N | N | A unique identifier for the script |
scriptVersionSelected | Float | N | Y | Y | N | N | The version of the script |
device | exec-disable. | N | Y | Y * | N | N | The device type on which the operation is to be performed |
scriptParam | exec-disable. | N | Y | Y | N | N |
The list of parameters needed by the script. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
paramName | String | N | Y | Y * | N | N | The parameter name |
paramValue | String | N | Y | Y * | N | N | The parameter value |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@href | String(URI) | N | Y | Y | Link to an external device. |
@uri | String(URI) | N | Y | Y | Link to this device node in the current node context. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@href | String(URI) | N | Y | Y | Link to an external script. |
@uri | String(URI) | N | Y | Y | Link to this script node in the current node context. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
scriptMgmt | exec-enable. | N | Y | Y * | The set of inputs for the operation |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
script | exec-enable. | N | Y | Y * | N | N | A unique identifier for the script |
scriptVersionSelected | Float | N | Y | Y | N | N | The version of the script |
device | exec-enable. | N | Y | Y * | N | N |
The device type on which the operation is to be performed. |
scriptParam | exec-enable. | N | Y | Y | N | N |
The list of parameters needed by the script. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
paramName | String | N | Y | Y * | N | N | The parameter name |
paramValue | String | N | Y | Y * | N | N | The parameter value |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@href | String(URI) | N | Y | Y | Link to an external device. |
@uri | String(URI) | N | Y | Y | Link to this device node in the current node context. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@href | String(URI) | N | Y | Y | Link to an external script. |
@uri | String(URI) | N | Y | Y | Link to this script node in the current node context. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
devices | exec-publish-request. | N | Y | Y * | List of devices to which the template is published. |
resolved-variables | exec-publish-request. | N | Y | Y * | The list of resolved variables based on the device. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this devices node in the current node context. |
device | exec-publish-request. | N | Y | Y * | The device to which the template is published. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | N | Link to this device node in the current node context. |
@href | String(URI) | N | Y | Y * | N | N | Link to an external device. Hyperlink Template: /api/space/device-management/devices/{*ID}. |
id | Integer | Y | Y | N | Y | Y | |
name | String | Y | Y | N | Y | Y | Device Name. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this resolvedVariables node in the current node context. |
device | exec-publish-request. | N | Y | Y * | The list of resolved variables per device. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | N | Link to this resolvedVariablesPerDevice node in the current node context. |
device-id | Integer | N | Y | Y * | N | N | The ID of the device with the resolved variables. |
variables | exec-publish-request. | N | Y | Y * | N | N | The list of resolved variables on the device. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this variables node in the current node context. Hyperlink Template: /variables. |
@total | Integer | Y | Y | N | Total number of gen_exec-publish-request-resolved-variables-resolved-variables-variables in the API result set. |
variable | exec-publish-request. | N | Y | Y * | The resolved varialbe on the device. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | N | Link to this resolvedSingleVariable node in the current node context. |
values | exec-publish-request. | N | Y | Y | N | N | The values of the variable. |
name | String | N | Y | Y * | N | N | The name of the variable. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this values node in the current node context. |
@total | Integer | Y | Y | N | Total number of gen_exec-publish-request-resolved-variables-resolved-variables-variables-variables-values in the API result set. |
value | String[] | N | Y | Y * | The value of the variable. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | N | Y | Y | Link to this exec-remove node in the current node context. |
devices | exec-remove. | N | Y | Y * |
Devices on which the software package is to be removed. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
device | exec-remove. | N | Y | Y * |
The collection of devices on which the software package is to be removed. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@key | Integer | N | Y | Y | N | N | A unique identifier for the device |
@href | String(URI) | N | Y | Y | N | N | Link to an external device. |
@uri | String(URI) | N | Y | Y | N | N | Link to this device node in the current node context. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
scriptMgmt | exec-remove. | N | Y | Y * | The set of inputs for the operation |
forceRemove | boolean | N | Y | Y |
A flag that indicates whether to forcibly remove the association between a
device and script while removing the script from device. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
script | exec-remove. | N | Y | Y * | N | N |
A unique identifier for the script. |
scriptVersionSelected | Float | N | Y | Y | N | N |
The version of the script. |
device | exec-remove. | N | Y | Y * | N | N | The device type on which the operation is to be performed |
scriptParam | exec-remove. | N | Y | Y | N | N | The list of parameters needed by the script |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
paramName | String | N | Y | Y * | N | N | The parameter name |
paramValue | String | N | Y | Y * | N | N | The parameter value |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@href | String(URI) | N | Y | Y | Link to an external device. |
@uri | String(URI) | N | Y | Y | Link to this device node in the current node context. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@href | String(URI) | N | Y | Y | Link to an external script. |
@uri | String(URI) | N | Y | Y | Link to this script node in the current node context. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | N | Y | Y | Link to this exec-restore node in the current node context. |
exec-restore-specs | exec-restore. | N | Y | Y | A list of specs, each of which contain a device link for the device to be restored. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@size | Integer | N | Y | Y | Total number of devices or configuration files to be restored (or were restored). |
@uri | String(URI) | N | Y | Y | Link to this configFileMOs node in the current node context. |
exec-restore-spec | exec-restore. | N | Y | Y | A single restore-spec. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@uri | String(URI) | N | Y | Y | N | N | Link to this configFileMO node in the current node context. |
@href | String(URI) | N | Y | Y | N | N | Link to an external configFileMO. |
restoreType | String | N | Y | Y | N | N | Restore merge option. |
latestVersion | Integer | N | Y | Y | N | N | Latest version number. |
id | int | N | Y | Y | N | N | Latest version ID. |
config-file-version | String | N | Y | Y | N | N | Which version of the config file to restore. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this exec-rpc-job-results node in the current node context. |
@total | Integer | Y | Y | N | Total number of exec-rpc-job-results in the API result set. |
exec-rpc-job-result | exec-rpc-job-results. | N | Y | Y * |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | N | Link to this execRPCJobResult node in the current node context. |
id | Integer | Y | Y | N | Y | Y | ID of the RPC in the execute RPC job result. |
result | String | N | Y | Y * | Y | Y | Result of the RPC executed on the device. |
rpc | String | N | Y | Y * | Y | Y | RPC executed on the device. |
status | String | N | Y | Y * | Y | Y | Status of the RPC executed on the device. |
device-id | Integer | N | Y | Y * | Y | Y | ID Device of the on which the RPC is executed. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
scriptMgmt | exec-scripts. | N | Y | Y * | The set of inputs for the operation |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
script | exec-scripts. | N | Y | Y * | N | N | A unique identifier for the script |
scriptVersionSelected | Float | N | Y | Y | N | N | The version of the script |
device | exec-scripts. | N | Y | Y * | N | N | The device type on which the operation is to be performed |
scriptParam | exec-scripts. | N | Y | Y | N | N |
The list of parameters needed by the script. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
paramName | String | N | Y | Y * | N | N | The parameter name |
paramValue | String | N | Y | Y * | N | N | The parameter value |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@href | String(URI) | N | Y | Y | Link to an external device. |
@uri | String(URI) | N | Y | Y | Link to this device node in the current node context. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@href | String(URI) | N | Y | Y | Link to an external script. |
@uri | String(URI) | N | Y | Y | Link to this script node in the current node context. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | N | Y | Y | Link to this exec-stage node in the current node context. |
devices | exec-stage. | N | Y | Y * |
Devices on which the software package is to be staged. |
stageOptions | exec-stage. | N | Y | Y |
Type 'installOptions' specifies the different staging options for the software package. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
device | exec-stage. | N | Y | Y * |
The collection of devices on which the software package is to be staged. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@key | Integer | N | Y | Y | N | N | A unique identifier for the device |
@href | String(URI) | N | Y | Y | N | N | Link to an external device. |
@uri | String(URI) | N | Y | Y | N | N | Link to this device node in the current node context. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
cleanUpExistingOnDevice | Boolean | N | Y | Y |
The condition specifying whether the existing software package on the device should be cleaned up. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this exec-undeploy node in the current node context. |
devices | exec-undeploy. | N | Y | Y * | Devices from which the JAM Package is to be Undeployed. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this devices node in the current node context. Hyperlink Template: /devices. |
device | exec-undeploy. | N | Y | Y * | A collection of Devices from which the JAM Package is to be Undeployed. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@href | String(URI) | N | Y | Y * | N | N | Link to an external device. Hyperlink Template: /api/space/device-management/devices/{*ID}. |
id | Integer | Y | Y | N | Y | Y | ID of the Device from which the JAM package is to be Undeployed. |
name | String | Y | Y | N | Y | Y | Name of the Device from which the JAM package is to be Undeployed. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
devices | exec-undeploy-request. | N | Y | Y * | The the list of devices for template undeployment. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | N | Y | Y | Link to this deviceLists node in the current node context. |
device | exec-undeploy-request. | N | Y | Y * | The device from which to undeploy the configuration template. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@href | String(URI) | N | Y | Y * | N | N | Link to an external device. Hyperlink Template: /api/space/device-management/devices/{*ID}. |
@uri | String(URI) | Y | Y | N | N | N | Link to this device node in the current node context. |
id | Integer | Y | Y | N | N | N | The ID of the device from which to undeploy the template. |
Field Name | Type | Read Only | GET | PUT / POST | Description | ||||||
---|---|---|---|---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this execute-export-device-configuration-request node in the current node context. |
||||||
x-date | String | N | Y | Y * | X Date. |
||||||
device-list | execute-export-device-configuration-request. | N | Y | Y * | |||||||
content-type | enum(content-type) | N | Y | Y * | Content Type. Possible Values:
|
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this deviceLists node in the current node context. Hyperlink Template: /device-list. |
device | execute-export-device-configuration-request. | N | Y | Y * | Device. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | N | Link to this device node in the current node context. Hyperlink Template: /device-list/{*ID}. |
@href | String(URI) | N | Y | Y * | N | N | Link to an external device. Hyperlink Template: /api/space/managed-domain/devices-require-polling/{*ID}. |
id | Integer | Y | Y | N | Y | Y | Device ID. |
name | String | Y | Y | N | Y | Y | Device Name. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
devices | execute-export-physical-inventory-request. | N | Y | Y * |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this devices node in the current node context. |
device | execute-export-physical-inventory-request. | N | Y | Y * |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@href | String(URI) | N | Y | Y * | N | N | Link to an external device. Hyperlink Template: /api/space/device-management/devices/{*ID}. |
id | Integer | Y | Y | N | Y | Y | Device ID. |
name | String | Y | Y | N | Y | Y | Device Name. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | N | Y | Y | Link to this exec-verify node in the current node context. |
devices | exec-verify. | N | Y | Y * |
The devices on which the software package is to be verified. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
device | exec-verify. | N | Y | Y * |
The collection of devices on which the software package is to be verified. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@key | Integer | N | Y | Y | N | N | The unique identifier for the device |
@href | String(URI) | N | Y | Y | N | N | Link to an external device. |
@uri | String(URI) | N | Y | Y | N | N | Link to this device node in the current node context. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
scriptMgmt | exec-verify. | N | Y | Y * |
The set of inputs for the operation. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
script | exec-verify. | N | Y | Y * | N | N | A unique identifier for the script |
scriptVersionSelected | Float | N | Y | Y | N | N | The version of the script |
device | exec-verify. | N | Y | Y * | N | N | The device type on which the operation is to be performed |
scriptParam | exec-verify. | N | Y | Y | N | N |
The list of parameters needed by the script. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
paramName | String | N | Y | Y * | N | N | The parameter name |
paramValue | String | N | Y | Y * | N | N | The parameter value |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@href | String(URI) | N | Y | Y | Link to an external device. |
@uri | String(URI) | N | Y | Y | Link to this device node in the current node context. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@href | String(URI) | N | Y | Y | Link to an external script. |
@uri | String(URI) | N | Y | Y | Link to this script node in the current node context. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this expanded-cli-configuration node in the current node context. |
*id | Integer | Y | Y | N | DeviceConfiguration ID. |
configuration | String | N | Y | Y * | Configuration. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
xpath-list | expanded-cli-configuration-request. | N | Y | Y | Xpath list. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this xpathLists node in the current node context. |
xpath | String[] | N | Y | Y * | Xpath for which the configuration will be fetched. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
configuration | String | N | Y | Y * |
The configuration string. |
id | Integer | N | Y | Y | Unique identifier for the expanded configuration |
method | String | N | Y | Y |
Represents a link to a POST method that is used to match the content of the configuration. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
configuration | String | N | Y | Y * |
The configuration string. |
id | Integer | N | Y | Y | Unique identifier for expanded configuration |
method | String | N | Y | Y |
This represent a link to a POST method that is used to match the content of the configuration. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this expanded-xml-configuration node in the current node context. |
*id | Integer | Y | Y | N | DeviceConfiguration ID. |
configuration | String | Y | Y | N | Configuration. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
xpath-list | expanded-xml-configuration-request. | N | Y | Y | Xpath list. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this xpathLists node in the current node context. |
xpath | String[] | N | Y | Y * | Xpath for which the configuration will be fetched. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
device-list | export-ctp-interface-request. | N | Y | Y * |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this deviceLists node in the current node context. |
device | export-ctp-interface-request. | N | Y | Y * |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@href | String(URI) | N | Y | Y * | N | N | Link to an external device. Hyperlink Template: /api/space/device-management/devices/{*ID}. |
id | Integer | Y | Y | N | Y | Y | Device ID. |
name | String | Y | Y | N | Y | Y | Device Name. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
device-list | export-ptp-interface-request. | N | Y | Y * |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this deviceLists node in the current node context. |
device | export-ptp-interface-request. | N | Y | Y * |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@href | String(URI) | N | Y | Y * | N | N | Link to an external device. Hyperlink Template: /api/space/device-management/devices/{*ID}. |
id | Integer | Y | Y | N | Y | Y | Device ID. |
name | String | Y | Y | N | Y | Y | Device Name. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
roles | export-roles-request. | N | Y | Y * |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this roles node in the current node context. |
role | export-roles-request. | N | Y | Y * |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@href | String(URI) | N | Y | Y * | N | N | Link to an external role. Hyperlink Template: /api/space/user-management/roles/{*ID}. |
name | String | Y | Y | N | N | N | Role Name. |
role-id | Integer | Y | Y | N | N | N | Role ID. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this fabric-health-report node in the current node context. Hyperlink Template: /api/space/fabric-management/fabric-health-reports/{*ID}. |
@href | String(URI) | Y | Y | N | Link to an external fabric-health-report. Hyperlink Template: /api/space/fabric-management/system-health-report/{*ID}. |
*id | Integer | Y | Y | N | FabricHealthReport ID. |
process | String | N | Y | Y * | Process. |
parameter | String | N | Y | Y * | Parameter. |
problem-detected | Boolean | N | Y | Y * | Problem Detected. Default: false. |
last-updated-time | String | N | Y | Y * | Last Updated Time. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this fabric-health-report-refs node in the current node context. |
@total | Integer | Y | Y | N | Total number of fabric-health-reports in the API result set. |
fabric-health-report | fabric-health-report-refs. | N | Y | Y * |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | N | Link to this fabricHealthReport node in the current node context. Hyperlink Template: /api/space/fabric-management/fabric-health-reports/{*ID}. |
@href | String(URI) | N | Y | Y * | N | N | Link to an external fabricHealthReport. Hyperlink Template: /api/space/fabric-management/fabric-health-reports/{*ID}. |
id | Integer | Y | Y | N | Y | Y | FabricHealthReport ID. |
process | String | Y | Y | N | Y | Y | Process. |
parameter | String | Y | Y | N | N | N | Parameter. |
problem-detected | Boolean | Y | Y | N | Y | Y | Problem Detected. Default: false. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this fabric-hprof-file node in the current node context. Hyperlink Template: /api/space/fabric-management/hprof-files/{*ID}. |
@href | String(URI) | Y | Y | N | Link to an external fabric-hprof-file. Hyperlink Template: /api/space/fabric-management/hprof-files/{*ID}. |
*id | Integer | Y | Y | N | ID. |
file-path | String | N | Y | Y * | Location of the HPROF file on the node. |
node-host-name | String | N | Y | Y * | Node Host Name. |
node-name | String | N | Y | Y * | Logical name assigned to the node. |
created-time | String | N | Y | Y * | Time when the HPROF file was created on the node. |
management-ip | String | Y | Y | N | IPv4 address for the node. |
management-ipv6 | String | Y | Y | N | IPv6 address for the node. |
fabric-node | fabric-hprof-file. | N | Y | Y * |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@href | String(URI) | N | Y | Y * | Link to an external fabricNode. Hyperlink Template: /api/space/fabric-management/fabric-nodes/{*ID}. |
id | Integer | Y | Y | N | FabricNode ID. |
name | String | Y | Y | N | FabricNode Name. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this fabric-hprof-files node in the current node context. |
@total | Integer | Y | Y | N | Total number of fabric-hprof-files in the API result set. |
fabric-hprof-file | fabric-hprof-files. | N | Y | Y * |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | N | Link to this fabricHprofFile node in the current node context. Hyperlink Template: /api/space/fabric-management/hprof-files/{*ID}. |
@href | String(URI) | Y | Y | N | N | N | Link to an external fabric-hprof-file. Hyperlink Template: /api/space/fabric-management/hprof-files/{*ID}. |
id | Integer | Y | Y | N | N | N | ID. |
file-path | String | N | Y | Y * | Y | Y | Location of the HPROF file on the node. |
node-host-name | String | N | Y | Y * | Y | Y | Node Host Name. |
node-name | String | N | Y | Y * | Y | Y | Logical name assigned to the node. |
created-time | String | N | Y | Y * | Y | Y | Time when the HPROF file was created on the node. |
management-ip | String | Y | Y | N | Y | Y | IPv4 address for the node. |
management-ipv6 | String | Y | Y | N | Y | Y | IPv6 address for the node. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this fabric-jboss-reboot-detail node in the current node context. Hyperlink Template: /api/space/fabric-management/fabric-jboss-reboot-details/{*ID}. |
@href | String(URI) | Y | Y | N | Link to an external fabric-jboss-reboot-detail. Hyperlink Template: /api/space/fabric-management/fabric-jboss-reboot-details/{*ID}. |
node-id | Integer | Y | Y | N | Node ID. |
node-name | String | N | Y | Y | Logical name assigned to the node. |
last-restart-time | String | N | Y | Y | Time when JBoss was last restarted on the node. |
management-ip | String | Y | Y | N | IPv4 address for the node. |
management-ip-v6 | String | Y | Y | N | IPv6 address for the node. |
fabric-node | fabric-jboss-reboot-detail. | N | Y | Y |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@href | String(URI) | N | Y | Y * | Link to an external fabricNode. Hyperlink Template: /api/space/fabric-management/fabric-nodes/{*ID}. |
id | Integer | Y | Y | N | FabricNode ID. |
name | String | Y | Y | N | FabricNode Name. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this fabric-jboss-reboot-details node in the current node context. |
@total | Integer | Y | Y | N | Total number of fabric-jboss-reboot-details in the API result set. |
fabric-jboss-reboot-detail | fabric-jboss-reboot-details. | N | Y | Y * |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | N | Link to this fabricJbossRebootDetail node in the current node context. Hyperlink Template: /api/space/fabric-management/fabric-jboss-reboot-details/{*ID}. |
@href | String(URI) | Y | Y | N | N | N | Link to an external fabricJbossRebootDetail. Hyperlink Template: /api/space/fabric-management/fabric-jboss-reboot-details/{*ID}. |
node-id | Integer | Y | Y | N | Y | Y | Node ID. |
node-name | String | N | Y | Y | Y | Y | Logical name assigned to the node. |
management-ip-v6 | String | Y | Y | N | Y | Y | IPv6 address for the node. |
last-restart-time | String | N | Y | Y | Y | Y | Time when JBoss was last restarted on the node. |
management-ip | String | Y | Y | N | Y | Y | IPv4 address for the node. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this fabric-large-table node in the current node context. Hyperlink Template: /api/space/fabric-management/fabric-large-tables/{*ID}. |
@href | String(URI) | Y | Y | N | Link to an external fabric-large-table. Hyperlink Template: /api/space/fabric-management/fabric-large-tables/{*ID}. |
*id | Integer | Y | Y | N | ID. |
db-name | String | N | Y | Y * | Type of database
E. Default: "MySQL". |
table-name | String | N | Y | Y * | Name of the table in the database. |
table-size | Float | N | Y | Y * | Size of the table in GB. |
time | String | N | Y | Y * | Time when the size of the database was last updated. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this fabric-large-tables node in the current node context. |
@total | Integer | Y | Y | N | Total number of fabric-large-tables in the API result set. |
fabric-large-table | fabric-large-tables. | N | Y | Y * |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | N | Link to this fabricLargeTable node in the current node context. Hyperlink Template: /api/space/fabric-management/fabric-large-tables/{*ID}. |
@href | String(URI) | Y | Y | N | N | N | Link to an external fabric-large-table. Hyperlink Template: /api/space/fabric-management/fabric-large-tables/{*ID}. |
id | Integer | Y | Y | N | Y | Y | ID. |
db-name | String | N | Y | Y * | N | N | Type of database
E. Default: "MySQL". |
table-name | String | N | Y | Y * | Y | Y | Name of the table in the database. |
table-size | Float | N | Y | Y * | Y | Y | Size of the table in GB. |
time | String | N | Y | Y * | N | N | Time when the size of the database was last updated. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this fabric-node node in the current node context. |
*id | Integer | Y | Y | N | Fabric Node ID. |
name | String | Y | Y | N | Logical name assigned to the node
NOTE: For the first node, Junos Space uses the node name that the user
specifies during the initial configuration of the Junos Space Appliance
(physical or virtual). |
management-ip-v4 | String | N | Y | Y | IPv4 address for the node. |
management-ip-v6 | String | N | Y | Y | IPv6 address for the node. |
node-type | String | Y | Y | N | The Description about the type of Node. |
space-node-type | String | Y | Y | N | The description about the type of Space Node. |
device-connection-ip-v4 | String | N | Y | Y | IPv4 address for connecting to the device. |
device-connection-ip-v6 | String | N | Y | Y | IPv6 address for the node. |
status | String | Y | Y | N | Connection status for the node. "UP"-Node is connected to the fabric "DOWN"-Node is disconnected from the fabric. |
last-monitored-time | Date | Y | Y | N | Node last monitored time. |
last-boot-time | Date | Y | Y | N | Last Boot Time. |
cpu-percentage | String | Y | Y | N | Percentage of CPU resource utilized by the node; from 0 to 100%. "Unknown"-Percentage of CPU utilized is unknown, for example, because the node is not connected. |
memory-percentage | String | Y | Y | N | Percentage of memory resource utilized by the node; from 0 to 100% "Unknown"-Percentage of memory utilized is unknown, for example, because the node is not connected. |
swap-percentage | String | Y | Y | N | Percentage of swap memory used. "Unknown"-Percentage of SWAP memory utilized is unknown, for example, because the node is not connected. |
disk-percentage | String | Y | Y | N | Percentage of the /var directory utilized by the node; from 0 to 100% "Unknown"-Percentage of the /var directory utilized by the node is unknown, for example, because the node is not connected. |
app-logic | String | Y | Y | N | Application logic function status for the node "UP" - Application logic function is running on the node "DOWN" - Application logic function enabled on the node but is not running "Unknown" - Status for the application logic function is unknown, for example, because the node is not connected "N/A" - Application logic function is not configured to run on the node "(Master)" - Configured primary Junos Space node in the fabric "FMPM (Master)" - Configured primary Fault Monitoring and Performance Monitoring (FMPM) node in the fabric "FMPM" - Configured secondary FMPM node in the fabric. |
database | String | Y | Y | N | Database function status for the node "UP" - Database function is running on the node "DOWN" - Database function that is enabled on the node but is not running "Unknown" - Status for the database function is unknown, for example, because the node is not connected "N/A" - Database function is not configured to run on the node NOTE: By default, the database function is enabled on no more than two nodes in the fabric. |
load-balancer | String | Y | Y | N | Load balancer function for the node "UP" - Load balancer function is running on the node "DOWN" - Load balancer function that is enabled on the node is not running "Unknown" - Status for the Load balancer function is unknown, for example, because the node might not be connected "N/A" - Load balancer function is not running because it is not configured to run on the node "(VIP)" - Configured virtual IP node in the fabric By default, the Load balancer function is enabled on no more than two nodes in the fabric. |
hardware-model | String | Y | Y | N | Model of the Junos Space Appliance. |
software-version | String | Y | Y | N | Junos Space Network Management Platform release version. |
serial-number | String | Y | Y | N | The serial number for the Junos Space Appliance. |
cluster-member-ips | String | Y | Y | N | IP addresses of the nodes in the fabric. |
is-master-node | Boolean | Y | Y | N | Indicates whether the node is a master node. |
is-vip-node | Boolean | Y | Y | N | Indicates whether the node is a virtual IP (VIP) node. |
host-ip | String | Y | Y | N | IP address of the hosted virtual machine. |
special-node-type | String | Y | Y | N | The description about the type of Special Node. |
fabric-node-status | String | Y | Y | N | The status of the fabric node. Hyperlink Template: /api/space/fabric-management/fabric-nodes/{*ID}/fabric-node-status. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this fabric-node-device-management-session node in the current node context. Hyperlink Template: /api/space/fabric-management/node-device-management-sessions/{*ID}. |
@href | String(URI) | Y | Y | N | Link to an external fabric-node-device-management-session. Hyperlink Template: /api/space/fabric-management/node-device-management-sessions/{*ID}. |
*id | Integer | Y | Y | N | ID. |
ip-v4 | String | Y | Y | N | IPv4 address for the node. |
ip-v6 | String | Y | Y | N | IPv6 address for the node. |
host | String | N | Y | Y * | Name of the host machine. |
status | String | N | Y | Y * | Connection status of the node. |
no-of-devices | Integer | N | Y | Y * | Number of device. |
no-of-devices-console-count | Integer | N | Y | Y * | Number of device management SSH sessions as calculated by the netstat command. |
last-update-time | String | N | Y | Y * | Time when the count of device management SSH sessions with devices was last calculated. |
fabric-node | fabric-node-device-management-session. | N | Y | Y * |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@href | String(URI) | N | Y | Y * | Link to an external fabricNode. Hyperlink Template: /api/space/fabric-management/fabric-nodes/{*ID}. |
id | Integer | Y | Y | N | FabricNode ID. |
name | String | Y | Y | N | FabricNode Name. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this fabric-node-device-management-sessions node in the current node context. |
@total | Integer | Y | Y | N | Total number of fabric-node-device-management-sessions in the API result set. |
fabric-node-device-management-session | fabric-node-device-management-sessions. | N | Y | Y * |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | N | Link to this fabricNodeDeviceManagementSession node in the current node context. Hyperlink Template: /api/space/fabric-management/node-device-management-sessions/{*ID}. |
@href | String(URI) | Y | Y | N | N | N | Link to an external fabric-node-device-management-session. Hyperlink Template: /api/space/fabric-management/node-device-management-sessions/{*ID}. |
id | Integer | Y | Y | N | Y | Y | ID. |
ip-v4 | String | Y | Y | N | Y | Y | IPv4 address for the node. |
ip-v6 | String | Y | Y | N | Y | Y | IPv6 address for the node. |
host | String | N | Y | Y * | Y | Y | Name of the host machine. |
status | String | N | Y | Y * | Y | Y | Connection status of the node. |
no-of-devices | Integer | N | Y | Y * | Y | Y | Number of device. |
no-of-devices-console-count | Integer | N | Y | Y * | Y | Y | Number of device management SSH sessions as calculated by the netstat command. |
last-update-time | String | N | Y | Y * | Y | Y | Time when the count of device management SSH sessions with devices was last calculated. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this fabric-nodes node in the current node context. |
@total | Integer | Y | Y | N | Total number of fabric-nodes in the API result set. |
fabric-node | fabric-nodes. | N | Y | Y * | Fabric node details. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | N | Link to this fabricNode node in the current node context. Hyperlink Template: /api/space/fabric-management/fabric-nodes/{*ID}. |
@href | String(URI) | Y | Y | N | N | N | Link to an external fabricNode. Hyperlink Template: /api/space/fabric-management/fabric-nodes/{*ID}. |
id | Integer | Y | Y | N | N | N | Fabric Node ID. |
name | String | Y | Y | N | Y | N | Logical name assigned to the node
NOTE: For the first node, Junos Space uses the node name that the user
specifies during the initial configuration of the Junos Space Appliance
(physical or virtual). |
management-ip-v4 | String | N | Y | Y | Y | N | IPv4 address for the node. |
management-ip-v6 | String | N | Y | Y | Y | N | IPv6 address for the node. |
node-type | String | Y | Y | N | N | N | The Description about the type of Node. |
software-version | String | Y | Y | N | N | N | Junos Space Network Management Platform release version. |
device-connection-ip-v4 | String | N | Y | Y | N | N | IPv4 address for connecting to the device. |
device-connection-ip-v6 | String | N | Y | Y | N | N | IPv6 address for connecting to the device. |
last-boot-time | Date | Y | Y | N | Y | Y | The last boot time of the node. |
last-monitored-time | Date | Y | Y | N | Y | Y | Node last monitored time. |
space-node-type | String | Y | Y | N | N | N | The description about the type of Space Node. |
status | String | Y | Y | N | Y | N | Connection status for the node. "UP"-Node is connected to the fabric "DOWN"-Node is disconnected from the fabric. |
app-logic | String | Y | Y | N | Y | N | Application logic function status for the node "UP" - Application logic function is running on the node "DOWN" - Application logic function enabled on the node but is not running "Unknown" - Status for the application logic function is unknown, for example, because the node is not connected "N/A" - Application logic function is not configured to run on the node "(Master)" - Configured primary Junos Space node in the fabric "FMPM (Master)" - Configured primary Fault Monitoring and Performance Monitoring (FMPM) node in the fabric "FMPM" - Configured secondary FMPM node in the fabric. |
database | String | Y | Y | N | Y | N | Database function status for the node "UP" - Database function is running on the node "DOWN" - Database function that is enabled on the node but is not running "Unknown" - Status for the database function is unknown, for example, because the node is not connected "N/A" - Database function is not configured to run on the node NOTE: By default, the database function is enabled on no more than two nodes in the fabric. |
load-balancer | String | Y | Y | N | Y | N | Load balancer function for the node "UP" - Load balancer function is running on the node "DOWN" - Load balancer function that is enabled on the node is not running "Unknown" - Status for the Load balancer function is unknown, for example, because the node might not be connected "N/A" - Load balancer function is not running because it is not configured to run on the node "(VIP)" - Configured virtual IP node in the fabric By default, the Load balancer function is enabled on no more than two nodes in the fabric. |
host-ip | String | Y | Y | N | N | N | IP address of the hosted virtual machine. |
cpu-percentage | String | Y | Y | N | Y | N | Percentage of CPU resource utilized by the node; from 0 to 100%. "Unknown"-Percentage of CPU utilized is unknown, for example, because the node is not connected. |
memory-percentage | String | Y | Y | N | Y | N | Percentage of memory resource utilized by the node; from 0 to 100% "Unknown"-Percentage of memory utilized is unknown, for example, because the node is not connected. |
swap-percentage | String | Y | Y | N | Y | N | Percentage of swap memory used. "Unknown"-Percentage of SWAP memory utilized is unknown, for example, because the node is not connected. |
disk-percentage | String | Y | Y | N | N | N | Percentage of the /var directory utilized by the node; from 0 to 100% "Unknown"-Percentage of the /var directory utilized by the node is unknown, for example, because the node is not connected. |
special-node-type | String | Y | Y | N | Y | Y | The description about the type of Special Node. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this fabric-node-status node in the current node context. Hyperlink Template: /api/space/fabric-management/fabric-nodes/{*ID}/fabric-node-status. |
@href | String(URI) | Y | Y | N | Link to an external fabric-node-status. Hyperlink Template: /api/space/fabric-management/fabric-nodes/{*ID}/fabric-node-status. |
fabric-node-id | Integer | Y | Y | N | FabricNodeStatusInfo ID. |
reboot-detail | fabric-node-status. | N | Y | Y * | The reboot details of the fabric Node. |
processes | fabric-node-status. | N | Y | Y | The collection of various processes status running in a fabric Node. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this fabricRebootDetail node in the current node context. |
last-boot-time | Long | Y | Y | N | The time when the last boot operation happened in the fabric node. |
last-boot-by | String | Y | Y | N | The name of the user/process who triggered the last boot operation in the fabric node. |
last-boot-reason | String | Y | Y | N | The reason provided for the last boot operation in the fabric node. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this fabricProcessDetailCollections node in the current node context. |
process | fabric-node-status. | N | Y | Y * | The information about the process running in a fabric Node. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | N | Link to this fabricProcessDetail node in the current node context. |
process-name | String | Y | Y | N | N | N | The name of the process running in the node. |
status | String | Y | Y | N | N | N | The description of the status of the process running in the node. |
cpu-percentage | Double | Y | Y | N | N | N | The percentage of the CPU utilized by the process in the node. |
memory-percentage | Double | Y | Y | N | N | N | The percentage of the memory utilized by the process in the node. |
start-time | Long | Y | Y | N | N | N | The time when the process was started. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this feature node in the current node context. Hyperlink Template: /api/space/application-management/platform/features/{*ID}. |
@href | String(URI) | Y | Y | N | Link to an external feature. Hyperlink Template: /api/space/application-management/platform/features/{*ID}. |
*id | Integer | Y | Y | N | Unique key of the feature. |
name | String | N | Y | Y * | Name of the feature. |
enabled | Boolean | N | Y | Y * | States that whether the feature is enabled or not. Default: true. |
description | String | N | Y | Y * | Feature's description. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this features node in the current node context. |
@total | Integer | Y | Y | N | Total number of features in the API result set. |
feature | features. | N | Y | Y * | Feature's details. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | N | Link to this paradigmFeature node in the current node context. Hyperlink Template: /api/space/application-management/platform/features/{*ID}. |
@href | String(URI) | Y | Y | N | N | N | Link to an external paradigmFeature. Hyperlink Template: /api/space/application-management/platform/features/{*ID}. |
id | Integer | Y | Y | N | Y | Y | Unique key of the feature. |
name | String | N | Y | Y * | Y | Y | Name of the feature. |
enabled | Boolean | N | Y | Y * | Y | N | States that whether the feature is enabled or not. Default: true. |
description | String | N | Y | Y * | Y | Y | Feature's description. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
filter-string | String | N | Y | Y * | Filter String. |
devices | filter-equipment-holders-request. | N | Y | Y |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this devices node in the current node context. |
device | filter-equipment-holders-request. | N | Y | Y * |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@href | String(URI) | N | Y | Y * | N | N | Link to an external device. Hyperlink Template: /api/space/device-management/devices/{*ID}. |
id | Integer | Y | Y | N | Y | Y | Device ID. |
name | String | Y | Y | N | Y | Y | Device Name. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this filter-equipment-holders-response node in the current node context. |
@total | Integer | Y | Y | N | Total number of equipment-holders in the API result set. |
equipment-holder | filter-equipment-holders-response. | N | Y | Y * |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | N | Link to this equipmentHolder node in the current node context. Hyperlink Template: /api/space/managed-domain/equipment-holders/{*ID}. |
@href | String(URI) | Y | Y | N | N | N | Link to an external equipmentHolder. Hyperlink Template: /api/space/managed-domain/equipment-holders/{*ID}. |
id | Integer | Y | Y | N | N | Y | Object Id. |
name | String | Y | Y | N | N | Y | EquipmentHolder Name. |
device-id | Integer | Y | Y | N | N | Y | Device ID. |
belong-to | filter-equipment-holders-response. | Y | Y | N | N | N |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@href | String(URI) | Y | Y | N | Link to an external equipmentHolder_REF. Hyperlink Template: /api/space/managed-domain/equipment-holders/{*ID}. |
id | Integer | Y | Y | N | Object Id. |
name | String | Y | Y | N | EquipmentHolder Name. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this forwarding-criteria node in the current node context. |
@total | Integer | Y | Y | N | Total number of forwarding-criteria in the API result set. |
forwarding-criterion | forwarding-criteria. | N | Y | Y * |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | N | Link to this forwardingCriterion node in the current node context. Hyperlink Template: /api/space/audit-log-management/audit-log-forwarding/forwarding-criteria/{*ID}. |
@href | String(URI) | N | Y | Y * | N | N | Link to an external forwarding-criterion-ref. Hyperlink Template: /api/space/audit-log-management/audit-log-forwarding/forwarding-criteria/{*ID}. |
id | Integer | Y | Y | N | Y | Y | ForwardingCriterion ID. |
name | String | Y | Y | N | Y | Y | ForwardingCriterion Name. |
description | String | Y | Y | N | Y | Y | Description. |
syslog-server | forwarding-criteria. | Y | Y | N | N | N | |
enabled | Boolean | Y | Y | N | Y | Y | Enable the forwarding criterion. Default: false. |
last-updated-user | String | Y | Y | N | Y | Y | Last Updated User. |
last-updated-time | String | Y | Y | N | Y | Y | Last Updated Time. |
Field Name | Type | Read Only | GET | PUT / POST | Description | ||||||
---|---|---|---|---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this syslogServer node in the current node context. |
||||||
host-address | String | N | Y | Y * | Syslog Server Host Address. |
||||||
port | Integer | N | Y | Y * | Syslog Server Port. Default: 514 Min: 0 Max: 65535. |
||||||
protocol | enum(protocol) | N | Y | Y * | Syslog Server Protocol. Possible Values:
|
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this forwarding-criterion-ref node in the current node context. Hyperlink Template: /api/space/audit-log-management/audit-log-forwarding/forwarding-criteria/{*ID}. |
@href | String(URI) | Y | Y | N | Link to an external forwarding-criterion-ref. Hyperlink Template: /api/space/audit-log-management/audit-log-forwarding/forwarding-criteria/{*ID}. |
*id | Integer | Y | Y | N | ForwardingCriterion ID. |
name | String | N | Y | Y | ForwardingCriterion Name. |
description | String | N | Y | Y | Description. |
syslog-server | forwarding-criterion-ref. | N | Y | Y * | |
enabled | Boolean | N | Y | Y * | Enable the forwarding criterion. Default: false. |
filters | forwarding-criterion-ref. | N | Y | Y |
Field Name | Type | Read Only | GET | PUT / POST | Description | ||||||
---|---|---|---|---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this syslogServer node in the current node context. |
||||||
host-address | String | N | Y | Y * | Syslog Server Host Address. |
||||||
port | Integer | N | Y | Y | Syslog Server Port. Default: 514 Min: 0 Max: 65535. |
||||||
protocol | enum(protocol) | N | Y | Y * | Syslog Server Protocol. Possible Values:
|
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this filters node in the current node context. |
@total | Integer | Y | Y | N | Total number of gen_forwarding-criterion-filters in the API result set. |
filter | forwarding-criterion-ref. | N | Y | Y * |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | N | Link to this logFilter node in the current node context. |
||||||||||||||||||
attribute | String | N | Y | Y * | Y | Y | Attribute name. |
||||||||||||||||||
operator | enum(operator) | N | Y | Y * | Y | Y | Condition. Possible Values:
|
||||||||||||||||||
value | String | N | Y | Y * | Y | Y | Value. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
pass-phrase | String | N | Y | Y | Pass Phrase. |
algorithm | String | N | Y | Y * | |
key-size | String | N | Y | Y | Key Size. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
value | String | N | Y | Y * | Generated temporary password. |
Field Name | Type | Read Only | GET | PUT / POST | Description | ||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
parameter | enum(parameter) | N | Y | Y * | Parameter value on which the Devices should be aggregated. Possible Values:
|
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this get-device-statistics-response node in the current node context. |
parameter | String | N | Y | Y * | Parameter on which the Device(s) are aggregated. |
device-statistics | get-device-statistics-response. | N | Y | Y * | Collection of aggregated Device statistics. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this deviceStatisticsInfos node in the current node context. |
device-statistic | get-device-statistics-response. | N | Y | Y * | Aggregated Device statistic on the given parameter. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | N | Link to this deviceStatisticsInfo node in the current node context. |
name | String | N | Y | Y * | N | N | Parameter value on which the Device(s) are aggregated. |
value | String | N | Y | Y * | N | N | Aggregated value of the Device(s) on the given parameter. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
clientId | String | N | Y | Y | The ID of the client. |
queueUrl | String | N | Y | Y | A fully qualified queue URL where job progress notifications will be sent. |
device | get-syslog-events. | N | Y | Y * | A type to represent the devices |
text-pattern | String[] | N | Y | Y * | A type to represent the text-patterns |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@href | String(URI) | N | Y | Y | N | N | Link to an external syslogDevices. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this high-cpu-usage node in the current node context. Hyperlink Template: /api/space/fabric-management/high-cpu-usages/{*ID}. |
@total | Integer | Y | Y | N | Total number of high-cpu-usage in the API result set. |
@href | String(URI) | Y | Y | N | Link to an external high-cpu-usage. Hyperlink Template: /api/space/fabric-management/high-cpu-usages/{*ID}. |
*id | Integer | Y | Y | N | ID. |
node-name | String | N | Y | Y * | Logical name assigned to the node. |
node-ip | String | Y | Y | N | IPv4 address for the node. |
node-ipv6 | String | Y | Y | N | IPv6 address for the node. |
average-cpu-utilization | Double | N | Y | Y * | Average load on the CPU of the node. |
start-time | String | N | Y | Y * | Time from when the node reported high CPU usage. |
end-time | String | N | Y | Y * | Time to when the node reported high CPU usage. |
duration | Long | N | Y | Y * | Total duration of high CPU usage on the node in minutes. |
fabric-node | high-cpu-usage. | N | Y | Y * |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@href | String(URI) | N | Y | Y * | Link to an external fabricNode. Hyperlink Template: /api/space/fabric-management/fabric-nodes/{*ID}. |
id | Integer | Y | Y | N | FabricNode ID. |
name | String | Y | Y | N | FabricNode Name. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this high-cpu-usages node in the current node context. |
@total | Integer | Y | Y | N | Total number of high-cpu-usages in the API result set. |
high-cpu-usage | high-cpu-usages. | N | Y | Y * |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | N | Link to this highCPUUsage node in the current node context. Hyperlink Template: /api/space/fabric-management/high-cpu-usages/{*ID}. |
@href | String(URI) | Y | Y | N | N | N | Link to an external highCPUUsage. Hyperlink Template: /api/space/fabric-management/high-cpu-usages/{*ID}. |
id | Integer | Y | Y | N | N | N | ID. |
node-name | String | N | Y | Y | Y | Y | Logical name assigned to the node. |
node-ip | String | Y | Y | N | Y | Y | IPv4 address for the node. |
node-ipv6 | String | Y | Y | N | Y | Y | IPv6 address for the node. |
average-cpu-utilization | Double | N | Y | Y * | Y | Y | Average load on the CPU of the node. |
start-time | String | N | Y | Y | Y | Y | Time from when the node reported high CPU usage. |
end-time | String | N | Y | Y | Y | Y | Time to when the node reported high CPU usage. |
duration | Long | N | Y | Y | N | N | Total duration of high CPU usage on the node in minutes. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
base64-value | String | N | Y | Y * | Image as base64 encoded string. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
roles | import-roles-request. | N | Y | Y * |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this roles node in the current node context. |
role | import-roles-request. | N | Y | Y * |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@href | String(URI) | Y | Y | N | N | N | Link to an external role. Hyperlink Template: /api/space/user-management/roles/{*ID}. |
predefined | Boolean | Y | Y | N | Y | Y | Predefined. Default: false. |
id | Integer | Y | Y | N | Y | Y | Role ID. |
title | String | Y | Y | N | Y | Y | Title. |
description | String | N | Y | Y | Y | Y | Description. |
sharable | Boolean | Y | Y | N | N | N | Sharable. |
capabilities | import-roles-request. | N | Y | Y | N | N | |
lessTasks | String | N | Y | Y | N | N | Less Tasks. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this availableCaps node in the current node context. |
@total | Integer | Y | Y | N | Total number of gen_import-roles-request-roles-roles-available-caps in the API result set. |
capability | import-roles-request. | N | Y | Y * |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@href | String(URI) | Y | Y | N | N | N | Link to an external capability. Hyperlink Template: /api/space/user-management/capabilities/{*ID}. |
id | Integer | N | Y | Y * | N | N | Cap ID. |
name | String | N | Y | Y | N | N | Capability Name. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
schemas | install-schemas-svn-request. | N | Y | Y * |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this schemas node in the current node context. |
schema | install-schemas-svn-request. | N | Y | Y * |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | N | Link to this schema node in the current node context. Hyperlink Template: /api/space/schema-serviceupload-tgz-schema-file. |
device-family | String | N | Y | Y * | N | N | Device Family. |
release | String | N | Y | Y * | N | N | Release. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
schemas | install-schemas-tgz-request. | N | Y | Y * | List of schemas to install. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this schemas2 node in the current node context. |
schema | install-schemas-tgz-request. | N | Y | Y * | Single schema to install from a disk location on the Space Server. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | N | Link to this schema node in the current node context. Hyperlink Template: /api/space/schema-serviceupload-tgz-schema-file. |
schema-location | String | N | Y | Y * | N | N | Schema Location on the Space Server. |
device-family | String | N | Y | Y * | N | N | Device Family. bxos, ive-ic, ive-sa, junos, junos-es, junos-ex, junos-mag, junos-qf, junos-qfx, mssos, tcaos, vse-mcg. |
release | String | N | Y | Y * | N | N | Release. |
Field Name | Type | Read Only | GET | PUT / POST | PATCH | Description | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
@uri | String(URI) | N | Y | Y | N | Link to this job node in the current node context. Hyperlink Template: /api/space/job-management/jobs/{*ID}. |
||||||||||||||
@href | String(URI) | Y | Y | N | N | Link to an external job. Hyperlink Template: /api/space/job-management/jobs/{*ID}. |
||||||||||||||
*id | Integer | Y | Y | N | N | The ID of the job. |
||||||||||||||
name | String | Y | Y | N | N | The name of the job. |
||||||||||||||
percent-complete | Double | Y | Y | N | N | The percentage of job completion. |
||||||||||||||
mo-state | String | N | Y | Y | Y | Mo State. |
||||||||||||||
job-state | enum(job-state) | Y | Y | N | N | The current state of the job. Possible Values:
|
||||||||||||||
job-status | enum(job-status) | Y | Y | N | N | The current status of the job. Possible Values:
|
||||||||||||||
job-type | String | Y | Y | N | N | The type of job. |
||||||||||||||
job-params-summary | String | Y | Y | N | N | The summary of job parameters. |
||||||||||||||
job-parameter-data | String | Y | Y | N | N | The parameter with which the job is triggered. |
||||||||||||||
summary | String | Y | Y | N | N | A summary of the job. |
||||||||||||||
scheduled-start-time | String | Y | Y | N | N | The time that the job is scheduled to start. |
||||||||||||||
start-time | String | Y | Y | N | N | The time at which the job started. |
||||||||||||||
end-time | String | Y | Y | N | N | The time at which the job ended. |
||||||||||||||
owner | String | N | Y | Y * | Y | The user related to this job. |
||||||||||||||
repeat-cron | String | Y | Y | N | N | If recurrence is set as raw cron send it back for rest. |
||||||||||||||
schedule-string | String | Y | Y | N | N | A string representation of the job schedule. |
||||||||||||||
retry-group-id | Integer | Y | Y | N | N | Retry Group ID. |
||||||||||||||
retry-group | job. | Y | Y | N | N | Retry group job details. |
||||||||||||||
previous-retry-id | Integer | Y | Y | N | N | Previous retry job ID. |
||||||||||||||
previous-retry | job. | Y | Y | N | N | |||||||||||||||
detail-link | job. | Y | Y | N | N | |||||||||||||||
retry-supported | Boolean | Y | Y | N | N | This flag is to represent the current job does supports retry or not. Default: false. |
||||||||||||||
retry-job-link | job. | Y | Y | N | N | |||||||||||||||
supports-recurrence | Boolean | Y | Y | N | N | Supports Recurrence. Default: false. |
||||||||||||||
domain-id | Integer | Y | Y | N | N | The domain id of the job. |
||||||||||||||
domain-name | String | Y | Y | N | N | The domain name of the job. |
||||||||||||||
domain | String | Y | Y | N | N | Hyperlink Template: /api/space/domain-management/domains/{*ID}. |
||||||||||||||
cancel | String | Y | Y | N | N | Cancel Job Hyperlink Template: /api/space/job-management/jobs/{*ID}/cancel. |
||||||||||||||
progress-update | String | Y | Y | N | N | Job's progress update Hyperlink Template: /api/space/job-management/jobs/{*ID}/progress-update. |
||||||||||||||
reschedule-job | String | Y | Y | N | N | Reschedule this job Hyperlink Template: /api/space/job-management/jobs/{*ID}/reschedule-job. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@href | String(URI) | N | Y | Y * | Link to an external retryGroup. Hyperlink Template: /api/space/job-management/jobs/{*ID}. |
id | Integer | Y | Y | N | The ID of the job. |
name | String | Y | Y | N | MonitorableTaskInstanceManagedObject Name. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@href | String(URI) | N | Y | Y * | Link to an external previousRetry. Hyperlink Template: /api/space/job-management/jobs/{*ID}. |
id | Integer | Y | Y | N | The ID of the job. |
name | String | Y | Y | N | MonitorableTaskInstanceManagedObject Name. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@href | String(URI) | N | Y | Y * | Link to an external detailLink. Hyperlink Template: Heterogeneous. |
@uri | String(URI) | Y | Y | N | Link to this detailLink node in the current node context. |
@type | String | N | Y | Y | |
name | String | Y | Y | N | A link to details about the job. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this retryJobLink node in the current node context. |
@href | String(URI) | N | Y | Y * | Link to an external retryJobLink. Hyperlink Template: Heterogeneous. |
@type | String | N | Y | Y | |
content-type | String | Y | Y | N | Content Type of retry job. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | N | Y | Y | Link to this jobs node in the current node context. |
@total | Integer | Y | Y | N | Total number of jobs in the API result set. |
job | jobs. | N | Y | Y * |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
@uri | String(URI) | N | Y | Y | N | N | Link to this monitorableTaskInstanceManagedObject node in the current node context. Hyperlink Template: /api/space/job-management/jobs/{*ID}. |
||||||||||||||
@href | String(URI) | Y | Y | N | N | N | Link to an external monitorableTaskInstanceManagedObject. Hyperlink Template: /api/space/job-management/jobs/{*ID}. |
||||||||||||||
id | Integer | Y | Y | N | Y | Y | The ID of the job. |
||||||||||||||
name | String | Y | Y | N | Y | Y | The name of the job. |
||||||||||||||
percent-complete | Double | Y | Y | N | Y | Y | The percentage of job completion. |
||||||||||||||
mo-state | String | N | Y | Y | Y | Y | Mo State. |
||||||||||||||
job-state | enum(job-state) | Y | Y | N | Y | Y | The current state of the job. Possible Values:
|
||||||||||||||
job-status | enum(job-status) | Y | Y | N | Y | Y | The current status of the job. Possible Values:
|
||||||||||||||
job-type | String | Y | Y | N | Y | Y | The type of job. |
||||||||||||||
job-params-summary | String | Y | Y | N | N | N | The summary of job parameters. |
||||||||||||||
job-parameter-data | String | Y | Y | N | N | N | The parameter with which the job is triggered. |
||||||||||||||
summary | String | Y | Y | N | N | Y | A summary of the job. |
||||||||||||||
scheduled-start-time | String | Y | Y | N | Y | Y | The time that the job is scheduled to start. |
||||||||||||||
start-time | String | Y | Y | N | Y | Y | The time at which the job started. |
||||||||||||||
end-time | String | Y | Y | N | Y | Y | The time at which the job ended. |
||||||||||||||
owner | String | N | Y | Y * | Y | Y | The user related to this job. |
||||||||||||||
schedule-string | String | Y | Y | N | N | Y | A string representation of the job schedule. |
||||||||||||||
retry-group-id | Integer | Y | Y | N | Y | Y | Retry Group ID. |
||||||||||||||
previous-retry-id | Integer | Y | Y | N | Y | Y | Previous retry job ID. |
||||||||||||||
retry-supported | Boolean | Y | Y | N | N | N | This flag is to represent the current job does supports retry or not. Default: false. |
||||||||||||||
domain-id | Integer | Y | Y | N | N | Y | The domain id of the job. |
||||||||||||||
domain-name | String | Y | Y | N | N | N | The domain name of the job. |
||||||||||||||
domain | String | Y | Y | N | N | N | Hyperlink Template: /api/space/domain-management/domains/{*ID}. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this job-types node in the current node context. |
@total | Integer | Y | Y | N | Total number of job-types in the API result set. |
job-type | String[] | N | Y | Y * | Job Type. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | N | Y | Y | Link to this managed-element node in the current node context. |
device | managed-element. | N | Y | Y |
Information about a device to which the managed element is attached. |
ptps | managed-element. | N | Y | Y |
The signal termination and assurance functions supported by a port. |
loopback | ptp-ref | N | Y | Y |
Information about connection termination points that can be
accessed through /api/space/managed-domain/ptps/{id}. |
ipAddr | String | N | Y | Y | The IP address of the managed element |
id | Integer | N | Y | Y * | The ID of the managed element |
equipment-holders | String | N | Y | Y | A link to equipment holders. |
multilayer-subnetworks | String | N | Y | Y | A link to the subnetworks. |
routing-instances | String | N | Y | Y | A link to the routing instances. |
software-identities | String | N | Y | Y | A link to the software identities. |
routing-options | String | N | Y | Y | A link to the routing options. |
vlans | String | N | Y | Y | A link to the VLANs. |
routing-engines | String | N | Y | Y | A link to the routing engines. |
virtual-chassis | String | N | Y | Y | A link to the virtual chassis check. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | N | Y | Y | Link to this physicalTerminationPoints node in the current node context. |
ptp | managed-element. | N | Y | Y | A collection of physical termination points |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@href | String(URI) | N | Y | Y | N | N | Link to an external physicalTerminationPoint. |
@uri | String(URI) | N | Y | Y | N | N | Link to this physicalTerminationPoint node in the current node context. |
name | String | N | Y | Y | N | N | The name of the termination point |
type | String | N | Y | Y | N | N | The 'ptp' type |
encapsulation | String | N | Y | Y | N | N | The encapsulation of the PTP |
tagging | String | N | Y | Y | N | N | Not supported |
adminStatus | String | N | Y | Y | N | N | The administration status. |
operationStatus | String | N | Y | Y | N | N | The operation status of the termination point. |
speed | Integer | N | Y | Y | N | N | the speed of the termination point. |
mtu | Integer | N | Y | Y | N | N | The maximum transmission unit (MTU) size on the physical interface |
lacpBundle | String | N | Y | Y | N | N | The aggregated Ethernet interface to which this PTP belongs |
deviceId | String | N | Y | Y | N | N | Device ID |
ptpId | Integer | N | Y | Y * | N | N | The ID of the PTP. |
id | Integer | N | Y | Y * | N | N | The ID of the managed element |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@href | String(URI) | N | Y | Y | Link to an external device. |
deviceFamily | String | N | Y | Y | The device family to which the device belongs |
OSVersion | String | N | Y | Y | The Junos OS version. |
platform | String | N | Y | Y | The platform on which the device exists |
serialNumber | String | N | Y | Y | The serial number of the device. |
name | String | N | Y | Y | The name of the device. |
hostName | String | N | Y | Y | The host name of the device |
connectionstatus | String | N | Y | Y | The connection status of the device |
id | Integer | N | Y | Y * | The ID of the device |
ipAddr | String | N | Y | Y | The IP address of the device |
otp | String | N | Y | Y | A one time password used for the device connection |
managedStatus | String | N | Y | Y | The managed status of the device |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | N | Y | Y * | Link to this managed-elements node in the current node context. |
managed-element | managed-elements. | N | Y | Y |
The type representing managed elements for the specified device. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@href | String(URI) | N | Y | Y * | N | N | Link to an external jSManagedElement. |
@key | Integer | N | Y | Y * | N | N |
Unique identifier for the managed element. |
ipAddr | String | N | Y | Y | N | N | IP address of the device |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | N | Y | Y | Link to this managed-elements node in the current node context. |
@size | Integer | N | Y | Y | The number of managed elements |
managed-element | managed-elements. | N | Y | Y |
The managed element object represents the Junos OS view of a network
element. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@uri | String(URI) | N | Y | Y | N | N | Link to this managedElementDTO node in the current node context. |
@href | String(URI) | N | Y | Y | N | N | Link to an external managedElementDTO. |
@key | Integer | N | Y | Y | N | N | The primary ID of the managed element |
ipAddr | String | N | Y | Y | N | N | The IP address of the managed element |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | N | Y | Y | Link to this managed-elements node in the current node context. |
@size | Integer | N | Y | Y | The number of managed elements |
managed-element | managed-elements. | N | Y | Y |
The managed element object represents the Junos OS view of a network
element. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@uri | String(URI) | N | Y | Y | N | N | Link to this managedElementDTO node in the current node context. |
@href | String(URI) | N | Y | Y | N | N | Link to an external managedElementDTO. |
@key | Integer | N | Y | Y | N | N | The primary ID of the managed element |
ipAddr | String | N | Y | Y | Y | Y | The IP address of the managed element |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | N | Y | Y * | Link to this managed-status node in the current node context. |
status | String | N | Y | Y |
Managed status of the device. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
context-list | match-cli-configlets-by-context-request. | N | Y | Y * | List of context details. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this contextLists node in the current node context. |
context | String[] | N | Y | Y * | Context
Context is the Xpath based on which the configlets will be fetched. Example : /device[name="EX4200-200"]/interface-information/physical-interface. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this match-cli-configlets-by-context-response node in the current node context. |
cli-configlets | match-cli-configlets-by-context-response. | N | Y | Y | List of configlets. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this cliConfigletLists node in the current node context. |
cli-configlet | match-cli-configlets-by-context-response. | N | Y | Y * | Configlet details. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
@href | String(URI) | Y | Y | N | N | N | Link to an external cliConfigurationTemplate. Hyperlink Template: /api/space/configuration-management/cli-configlets/{*ID}. |
||||||||||
id | Integer | Y | Y | N | N | N | Configlet ID Unique key of the configlet. |
||||||||||
name | String | N | Y | Y * | Y | Y | Configlet Name The Name cannot exceed 255 characters. You cannot have two configlets with the same name in one domain. |
||||||||||
latest-version | String | Y | Y | N | Y | Y | Latest Version Latest version of the configlet. Default: "1.0". |
||||||||||
category | String | N | Y | Y | Y | Y | Category Category for which the configlet belongs to and this is an arbitrary value, which can be used for filtering. The Category cannot exceed 255 characters. |
||||||||||
description | String | N | Y | Y | N | N | Description Description of the configlet and it cannot exceed 2500 characters. |
||||||||||
device-family | String | N | Y | Y * | Y | Y | Device Family The device family for which the configlet will be applicable for. |
||||||||||
execution-type | enum(execution-type) | N | Y | Y | Y | Y | Types of Execution There are two types of execution types.
Possible Values:
Default: SINGLE. |
||||||||||
reference-number | Integer | N | Y | Y | Y | Y | Reference Number Reference Number the configlet belongs to and it is an arbitrary value, which can be used for filtering. Min: 1 Max: 65535. |
||||||||||
domain-id | Integer | Y | Y | N | N | Y | Domain ID It specifies the domain ID for which this configlet belongs to. |
||||||||||
domain-name | String | Y | Y | N | N | N | Domain Name Name of the domain for which the configlet belongs to. |
||||||||||
creation-time | Date | Y | Y | N | Y | Y | Creation Time The time when the configlet was created. |
||||||||||
last-updated-time | Date | Y | Y | N | Y | Y | Last Modified Time The time when the configlet was updated at last. |
||||||||||
last-modified-by | String | Y | Y | N | Y | Y | Last Modified user The name of the user who modified the configlet at last. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
context-list | match-scripts-by-context-request. | N | Y | Y * | Context list details. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this contextLists node in the current node context. |
context | String[] | N | Y | Y * | Context Context is the Xpath based on which the configlets will be fetched. Example : /device[name="EX4200-200"]/interface-information/physical-interface. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this match-scripts-by-context-response node in the current node context. |
scripts | match-scripts-by-context-response. | N | Y | Y | List of Scripts. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this scriptLists node in the current node context. |
script | match-scripts-by-context-response. | N | Y | Y * | Script details. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | N | Link to this script node in the current node context. Hyperlink Template: /api/space/script-management/scripts. |
@href | String(URI) | Y | Y | N | N | N | Link to an external script. Hyperlink Template: /api/space/script-management/scripts/{*ID}. |
id | Integer | Y | Y | N | N | N | Script ID. |
script-name | String | N | Y | Y | N | N | Name of the Script. |
domain-id | Integer | Y | Y | N | N | Y | Domain ID. |
domain-name | String | Y | Y | N | N | N | Domain Name the script belongs to. |
display-name | String | N | Y | Y | N | N | Display Name of the script. |
type | String | N | Y | Y | N | N | Script Type Type of Script could be one among the following 1. Default: "Op Script". |
category | String | N | Y | Y | N | N | Category
Category is an arbitrary value used for sorting/filtering. |
execution-type | String | N | Y | Y | N | N | Execution Type Type of execution could be one among the following 1. Default: "Device". |
format | String | N | Y | Y | N | N | Format Format could be one of the following 1. Default: "SLAX". |
lastest-revision | String | Y | Y | N | N | N | Lastest Revision. |
creation-time | Date | Y | Y | N | N | N | Creation Time. |
description | String | N | Y | Y | N | N | Description. |
last-update-time | Date | Y | Y | N | N | N | Last Update Time. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this menu-statuses node in the current node context. |
@total | Integer | Y | Y | N | Total number of menu-statuses in the API result set. |
menu | menu-statuses. | N | Y | Y * |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | N | Link to this menu node in the current node context. |
menu-status | Boolean | N | Y | Y * | N | N | Menu Status. |
menu-name | String | N | Y | Y * | N | N | Menu Name. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
tasks | menu-status-request. | N | Y | Y * | |
selected-object-ids | menu-status-request. | N | Y | Y |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this taskNames node in the current node context. |
task | String[] | N | Y | Y * | Task Names. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this selectedUserLists node in the current node context. |
selected-object-id | Integer[] | N | Y | Y * | Selected User Lists. |
Field Name | Type | Read Only | GET | PUT / POST | Description | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
@href | String(URI) | Y | Y | N | Link to an external modeled-instance. Hyperlink Template: /api/space/device-management/modeled-device-management/modeled-instances/{*ID}. |
||||||||||
@uri | String(URI) | Y | Y | N | Link to this modeled-instance node in the current node context. Hyperlink Template: /api/space/device-management/modeled-device-management/modeled-instances/{*ID}. |
||||||||||
*id | Integer | N | Y | Y | ID of the modeled instance. |
||||||||||
name | String | N | Y | Y * | Name of the modeled instance. |
||||||||||
description | String | N | Y | Y | Description of the modeled instance. |
||||||||||
device-family | String | N | Y | Y | Device Family types
SCREENOS("SCREENOS"),
JUNOS_ES("J/SRX/LN"),
JUNOS("ACX/J/M/MX/T/TX/PTX/EX92xx/EX43xx"),
JUNOS_EX("EX"),
JUNOS_QF("QF"),
JUNOS_QFX("QFX"),
BXOS("BXOS"),
TCAOS("TCAOS");. |
||||||||||
connection-profile-type | enum(connection-profile-type) | N | Y | Y | The Connection type (for example; DHCP, PPPoA, PPPoE, Static). Possible Values:
|
||||||||||
platform | String | N | Y | Y * | Platform of the devices. |
||||||||||
device-count | Integer | N | Y | Y | Number of devices, This will be overridden if deviceUnits are explicitly defined. Default: 1. |
||||||||||
devices | String | Y | Y | N | View modeled instance devices. Hyperlink Template: /api/space/device-management/modeled-device-management/modeled-instances/{*ID}/devices. |
||||||||||
configlets | String | Y | Y | N | Configlet for the devices Hyperlink Template: /api/space/device-management/modeled-device-management/modeled-instances/{*ID}/configlets. |
||||||||||
add-more-devices | String | Y | Y | N | Add More devices Hyperlink Template: /api/space/device-management/modeled-device-management/modeled-instances/{*ID}/add-more-devices. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this modeled-instance-activate-later node in the current node context. |
name | String | N | Y | Y * | Name of the modeled instance. |
description | String | N | Y | Y | Description for modeled instance. |
tag-name | String | N | Y | Y | Tag devices with this tag. |
number-of-devices | Integer | N | Y | Y | Number of devices, This will be overridden if deviceUnits are explicitly defined. Default: 1 Min: 1 Max: 200. |
platform | String | N | Y | Y * | Platform of the devices. |
template | modeled-instance-activate-later. | N | Y | Y | Device template href. |
device-image | modeled-instance-activate-later. | N | Y | Y | Device image href. |
devices | modeled-instance-activate-later. | N | Y | Y | List of modeled device which contains details like device-name, platform, os-version, serial-number. |
snmp-setting | modeled-instance-activate-later. | N | Y | Y | Parameters to configure SNMPV1/V2C/V3. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this configTemplateInfo node in the current node context. |
@href | String(URI) | N | Y | Y * | Link to an external configTemplateInfo. Hyperlink Template: /api/space/config-template-management/config-templates/{*ID}. |
id | Integer | Y | Y | N | Id of the template. |
name | String | Y | Y | N | Name of the template. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this deviceImage node in the current node context. |
@href | String(URI) | N | Y | Y * | Link to an external deviceImage. Hyperlink Template: /api/space/software-management/packages/{*ID}. |
id | Integer | Y | Y | N | Id of the device image. |
name | String | Y | Y | N | Name of the device image. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this deviceUnits node in the current node context. |
device | modeled-instance-activate-later. | N | Y | Y * | Modeled device which contains details like device-name, platform, os-version, serial-number. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | N | Link to this deployDeviceUnit node in the current node context. |
device-name | String | N | Y | Y | N | N | Name of the device. |
platform | String | N | Y | Y | N | N | Platform of the device. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this snmpSettingREST node in the current node context. |
snmp-v1-setting | modeled-instance-activate-later. | N | Y | Y | SNMPV1 parameters used for polling. |
snmp-v2c-setting | modeled-instance-activate-later. | N | Y | Y | SNMPV2C parameters used for polling. |
snmp-v3-setting | modeled-instance-activate-later. | N | Y | Y | SNMPV3 parameters used for polling. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this snmpV1SettingREST node in the current node context. |
community-name | String | N | Y | Y | Community name for SNMP V1. Default: "public". |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this snmpV2CSettingREST node in the current node context. |
community-name | String | N | Y | Y | Community name for SNMP V2C. Default: "public". |
Field Name | Type | Read Only | GET | PUT / POST | Description | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this snmpV3SettingREST node in the current node context. |
||||||||||
user-name | String | N | Y | Y * | SNMP V3 user name. |
||||||||||
authentication-type | enum(authentication-type) | N | Y | Y | SNMP V3 Authentication protocol
If the authentication-type is NONE then the fields authentication-password, privacy-type, privacy-password are not applicable. Possible Values:
Default: MD5. |
||||||||||
authentication-password | String | N | Y | Y | SNMP V3 User's authentication password
The password should contain minimum of 8 characters and maximum 1024 characters. |
||||||||||
privacy-type | enum(privacy-type) | N | Y | Y | SNMP V3 Privacy protocol
If the privacy-type is NONE then the field privacy-password is not applicable. Possible Values:
Default: DES. |
||||||||||
privacy-password | String | N | Y | Y | SNMP V3 User's privacy password
The password should contain minimum of 8 characters and maximum 1024 characters. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this modeled-instance-activate-now node in the current node context. |
name | String | N | Y | Y * | Name of the modeled instance. |
description | String | N | Y | Y | Description for modeled instance. |
tag-name | String | N | Y | Y | Tag devices with this tag. |
platform | String | N | Y | Y * | Platform of the devices. |
number-of-devices | Integer | N | Y | Y | Number of devices, This will be overridden if deviceUnits are explicitly defined. Default: 1 Min: 1 Max: 200. |
template | modeled-instance-activate-now. | N | Y | Y | Device template href. |
device-image | modeled-instance-activate-now. | N | Y | Y | Device image href. |
activation-parameters | modeled-instance-activate-now. | N | Y | Y * | Parameters for activating model device connection like device-credentials, connection establishment details and validation details. |
devices | modeled-instance-activate-now. | N | Y | Y | List of modeled device which contains details like device-name, platform, os-version, serial-number. |
snmp-setting | modeled-instance-activate-now. | N | Y | Y | Parameters for SNMP settings like SNMP V1/V2C/V3. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this configTemplateInfo node in the current node context. |
@href | String(URI) | N | Y | Y * | Link to an external configTemplateInfo. Hyperlink Template: /api/space/config-template-management/config-templates/{*ID}. |
id | Integer | Y | Y | N | Id of the template. |
name | String | Y | Y | N | Name of the template. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this deviceImage node in the current node context. |
@href | String(URI) | N | Y | Y * | Link to an external deviceImage. Hyperlink Template: /api/space/software-management/packages/{*ID}. |
id | Integer | Y | Y | N | Id of the device image. |
name | String | Y | Y | N | Name of the device image. |
Field Name | Type | Read Only | GET | PUT / POST | Description | ||||||
---|---|---|---|---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this deployInstanceActiveNowMOREST node in the current node context. |
||||||
user-name | String | N | Y | Y * | Username to authenticate with the device. |
||||||
key-based | Boolean | N | Y | Y | Should key based authentication be performed. Default: false. |
||||||
password | String | N | Y | Y | Password to authenticate with the device, mandatory if key-based is not set to true. |
||||||
serial-number-validation | Boolean | N | Y | Y | Perform serial Number validation while adding device to space. Default: false. |
||||||
host-name-validation | Boolean | N | Y | Y | Perform host name validation while adding device to space. Default: false. |
||||||
connection-profile | modeled-instance-activate-now. | N | Y | Y * | Connection-profile which Contains connection-establishment parameters like ip details, NAT details, connection-type(DHCP,ADSL,PPPoaA,PPPoE) and its sub-parameters. |
||||||
configuration-update-type | enum(configuration-update-type) | N | Y | Y | Configuration update type, if Automatic, the configuration will be updated once the device connects space. Possible Values:
Default: AUTOMATIC. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this connectionProfileMOREST node in the current node context. Hyperlink Template: /api/space/device-management/modeled-device-management/connection-profile-rests/{*ID}. |
@href | String(URI) | N | Y | Y * | Link to an external connectionProfileMOREST. Hyperlink Template: /api/space/device-management/modeled-device-management/connection-profiles/{*ID}. |
id | Integer | Y | Y | N | ID of the conneciton profile. |
name | String | Y | Y | N | Name of the connection profile. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this deviceUnits node in the current node context. |
device | modeled-instance-activate-now. | N | Y | Y * | Modeled device which contains details like device-name, platform, os-version, serial-number. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | N | Link to this deployDeviceUnit node in the current node context. |
device-name | String | N | Y | Y | N | N | Name of the device. |
platform | String | N | Y | Y | N | N | Platform of the device. |
os-version | String | N | Y | Y | N | N | OS version of the device. |
serial-number | String | N | Y | Y | N | N | Serial Number of device. |
static-ip | String | N | Y | Y | N | N | Static IP address with prefix(subnet mask). For example 192. |
gateway | String | N | Y | Y | N | N | Gateway for static IP. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this snmpSettingREST node in the current node context. |
snmp-v1-setting | modeled-instance-activate-now. | N | Y | Y | SNMPV1 parameters used for polling. |
snmp-v2c-setting | modeled-instance-activate-now. | N | Y | Y | SNMPV2C parameters used for polling. |
snmp-v3-setting | modeled-instance-activate-now. | N | Y | Y | SNMPV3 parameters used for polling. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this snmpV1SettingREST node in the current node context. |
community-name | String | N | Y | Y | Community name for SNMP V1. Default: "public". |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this snmpV2CSettingREST node in the current node context. |
community-name | String | N | Y | Y | Community name for SNMP V2C. Default: "public". |
Field Name | Type | Read Only | GET | PUT / POST | Description | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this snmpV3SettingREST node in the current node context. |
||||||||||
user-name | String | N | Y | Y * | SNMP V3 user name. |
||||||||||
authentication-type | enum(authentication-type) | N | Y | Y | SNMP V3 Authentication protocol
If the authentication-type is NONE then the fields authentication-password, privacy-type, privacy-password are not applicable. Possible Values:
Default: MD5. |
||||||||||
authentication-password | String | N | Y | Y | SNMP V3 User's authentication password
The password should contain minimum of 8 characters and maximum 1024 characters. |
||||||||||
privacy-type | enum(privacy-type) | N | Y | Y | SNMP V3 Privacy protocol
If the privacy-type is NONE then the field privacy-password is not applicable. Possible Values:
Default: DES. |
||||||||||
privacy-password | String | N | Y | Y | SNMP V3 User's privacy password
The password should contain minimum of 8 characters and maximum 1024 characters. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this modeled-instances node in the current node context. |
@total | Integer | Y | Y | N | Total number of modeled-instances in the API result set. |
modeled-instance | modeled-instances. | N | Y | Y * | List of modeled device with device-family and its associated connection type. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
@href | String(URI) | N | Y | Y * | N | N | Link to an external deployInstance. Hyperlink Template: /api/space/device-management/modeled-device-management/modeled-instances/{*ID}. |
||||||||||
@uri | String(URI) | Y | Y | N | N | N | Link to this deployInstance node in the current node context. Hyperlink Template: /api/space/device-management/modeled-device-management/modeled-instances/{*ID}. |
||||||||||
id | Integer | Y | Y | N | N | N | Id of the modeled instance. |
||||||||||
name | String | Y | Y | N | Y | Y | Name of the modeled instance. |
||||||||||
description | String | Y | Y | N | N | N | Description of the modeled instance. |
||||||||||
device-family | String | Y | Y | N | N | N | Device Family types
SCREENOS("SCREENOS"),
JUNOS_ES("J/SRX/LN"),
JUNOS("ACX/J/M/MX/T/TX/PTX/EX92xx/EX43xx"),
JUNOS_EX("EX"),
JUNOS_QF("QF"),
JUNOS_QFX("QFX"),
BXOS("BXOS"),
TCAOS("TCAOS");. |
||||||||||
connection-profile-type | enum(connection-profile-type) | Y | Y | N | N | N | Connection profile to be associated. Possible Values:
|
||||||||||
device-count | Integer | Y | Y | N | Y | Y | Number of devices, This will be overridden if deviceUnits are explicitly defined. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
new-ip-address | String | N | Y | Y * | The new IP of the device. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | N | Y | Y | Link to this multilayer-subnetwork node in the current node context. |
managed-element | managed-element[] | N | Y | Y | The managed elements associated with the subnetwork. |
tcp | JSTerminationPoint[] | N | Y | Y | A collection of multilayer subnetworks |
topological-link | JSTopologicalLink[] | N | Y | Y | A collection of topological links. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | N | Y | Y | Link to this multilayer-subnetworks node in the current node context. |
@size | Integer | N | Y | Y | The size of the collection. |
multilayer-subnetwork | multilayer-subnetworks. | N | Y | Y |
This resource model represents the topology provided by the Junos OS. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@key | Integer | N | Y | Y * | N | N | The ID of the subnetwork |
@uri | String(URI) | N | Y | Y | N | N | Link to this multiLayerSubnetwork node in the current node context. |
id | Integer | N | Y | Y * | N | N | The ID of the managed element |
name | String | N | Y | Y | N | N | The name of the subnetwork. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
imageFileData | byte[] | N | Y | Y | Byte stream for the device image file |
imageFileName | String | N | Y | Y | Name of the device image file |
Field Name | Type | Read Only | GET | PUT / POST | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
@key | Integer | N | Y | Y | A unique identifier for the software package | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
@uri | String(URI) | N | Y | Y | Link to this package node in the current node context. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
fileName | String | N | Y | Y | Name of the software package | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
type | String | N | Y | Y | Type of the software package | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
fileMD5 | String | N | Y | Y | MD5 checksum of the software package | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
version | String | N | Y | Y |
Version of the software package. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
size | Long | N | Y | Y |
Size of software package in bytes. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
decodeStatus | enum(decodeStatus) | N | Y | Y |
File decode status of the software package from base64 encoded form. Possible Values:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
uploadStatus | enum(uploadStatus) | N | Y | Y |
Package file upload status. Possible Values:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
allowDelete | Boolean | N | Y | Y |
Whether or not to allow the deletion of the software package. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
uploadTime | String | N | Y | Y |
The starting time when the software package was uploaded to the system. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
supportedPlatforms | package. | N | Y | Y |
All the device platforms on which the software package can be installed. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
supportedSeries | package. | N | Y | Y |
All the device series on which the software package can be deployed. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
deviceSeries | enum(deviceSeries) | N | Y | Y * |
The type of platform for the software package. Possible Values:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
method | String | N | Y | Y |
Supported operations for software management provided by Junos Space. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
method | String | N | Y | Y |
This is an attribute of the package that provides a link to the API, which can be used to deploy the software package on device. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
method | String | N | Y | Y |
This is an attribute of the package that provides a link to the API, which can be used to the verify the software package on device. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
method | String | N | Y | Y |
This is an attribute of the package that provides a link to the API, which can be used to remove the software package from device. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
method | String | N | Y | Y |
This is an attribute of the package that provides a link to the API, which can be used to undeploy the software package on device. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
associated-devices | String | N | Y | Y |
This is an attribute of the package that provides a link to the API, which can be used to view which devices have got this image staged. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
platform | String[] | N | Y | Y |
A collection of platforms. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
series | String[] | N | Y | Y |
A collection of series. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@size | Integer | N | Y | Y |
Total number of uploaded software packages (device images). |
@uri | String(URI) | N | Y | Y | Link to this packages node in the current node context. |
package | packages. | N | Y | Y * |
A collection of software packages. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
@uri | String(URI) | N | Y | Y | N | N | Link to this deviceImageMO node in the current node context. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
@href | String(URI) | N | Y | Y * | N | N | Link to an external deviceImageMO. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
@key | String | N | Y | Y | N | N |
Unique identifier for the software package. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
fileName | String | N | Y | Y * | N | N | Name of the software package | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
type | String | N | Y | Y * | N | N | Type of the software package | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
version | String | N | Y | Y * | N | N |
Version of the software package. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
platformType | enum(platformType) | N | Y | Y * | N | N |
The platform of the device. Possible Values:
|
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
value | String | N | Y | Y * | The password of the user. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | N | Y | Y | Link to this password node in the current node context. |
Minimum-number-of-characters | Integer | N | Y | Y |
The minimum number of characters allowed in the password. |
Number-of-previous-passwords-cannot-be-reused | Integer | N | Y | Y |
Number of previous passwords that cannot be reused. |
Number-of-unsuccessful-login-attempts | Integer | N | Y | Y |
Number of successful login attempts. |
Time-interval-for-lockout-in-hours | Integer | N | Y | Y |
Time interval for lockout of account in hours. |
Time-interval-for-password-expiry-in-months | Integer | N | Y | Y |
Time interval for password expiry in months. |
Time-interval-for-password-expiry-notification-in-months | Integer | N | Y | Y |
Time interval for password expiry. |
At-least-one-lowercase-character | String | N | Y | Y |
Password should contain at least one lowercase character. |
At-least-one-uppercase-character | String | N | Y | Y |
Password should contain at least one uppercase character. |
At-least-one-number-not-in-the-last-position | String | N | Y | Y |
Password should contain at least one number that is not in the last position. |
At-least-one-special-character-not-in-the-last-position | String | N | Y | Y |
Password should contain at least one special character that is not in the last position. |
Not-repeat-of-the-user-ID | String | N | Y | Y |
Password should not be the same as the user ID. |
Not-reverse-of-the-user-ID | String | N | Y | Y |
Password should not be the reverse of the user ID. |
No-more-than-three-repetitive-characters | String | N | Y | Y |
Password should not contain more than three repetitive characters. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | N | Y | Y | Link to this platform node in the current node context. |
title | String | N | Y | Y * | Title representing the Junos Space |
version | String | N | Y | Y * | Version of Junos Space |
subVersion | String | N | Y | Y * | Sub-version of Junos Space |
description | String | N | Y | Y * | Description of Junos Space |
settings | String | N | Y | Y * |
Location of 'settings' resource. |
features | String | N | Y | Y * |
Location of 'features' resource. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this preview-cli-configlet-request node in the current node context. |
context | String | N | Y | Y | Context. |
cli-configlet-params | preview-cli-configlet-request. | N | Y | Y | All the parameters of the Configlet. |
device | preview-cli-configlet-request. | N | Y | Y * | The device to which the configlet needs to be applied. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this cliConfigletParams node in the current node context. |
cli-configlet-param | preview-cli-configlet-request. | N | Y | Y * | The configlet parameter and value. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | N | Link to this configletParamForNBI node in the current node context. |
parameter | preview-cli-configlet-request. | N | Y | Y | N | N | The parameter in the Configlet. |
param-value | String | N | Y | Y * | N | N | Parameter Value. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@href | String(URI) | N | Y | Y * | Link to an external paramForNBI. Hyperlink Template: /api/space/configuration-management/cli-configlets/{*ID}/cli-configlet-params/{*ID}. |
param-id | Integer | Y | Y | N | Configlet parameter ID. |
name | String | Y | Y | N | Parameter Name. |
configlet-id | Integer | Y | Y | N | Configlet ID. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@href | String(URI) | N | Y | Y * | Link to an external device. Hyperlink Template: /api/space/device-management/devices/{*ID}. |
id | Integer | Y | Y | N | Device ID. |
name | String | Y | Y | N | Device Name. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
value | String | N | Y | Y * | Value. |
Field Name | Type | Read Only | GET | PUT / POST | Description | ||||||
---|---|---|---|---|---|---|---|---|---|---|---|
@uri | String(URI) | N | Y | Y | Link to this profile node in the current node context. |
||||||
@read-only | Boolean | N | Y | Y | A flag that indicates whether the remote profile is read-only. |
||||||
id | Integer | N | Y | Y | The HREF ID of the remote profile. |
||||||
name | String | N | Y | Y * | The remote profile name. |
||||||
description | String | N | Y | Y | The remote profile description. |
||||||
viewAllObjects | Boolean | N | Y | Y | User can view all jobs or user's own jobs in job manager | ||||||
roleType | enum(roleType) | N | Y | Y | The RBAC role access type for the remote profile. Possible Values:
|
||||||
api-access-profile | profile. | N | Y | Y | REST API access restriction rule for user. |
||||||
roles | profile. | N | Y | Y * | The roles associated with the remote profile. |
||||||
domains | profile. | N | Y | Y |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | N | Y | Y | Link to this remoteProfileRoles node in the current node context. |
role | profile. | N | Y | Y * |
The collection of objects of type 'userrole'. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@href | String(URI) | N | Y | Y * | N | N | Link to an external remoteProfileRole. |
@uri | String(URI) | N | Y | Y | N | N | Link to this remoteProfileRole node in the current node context. |
id | Integer | N | Y | Y | N | N |
A identifier for the user role. |
name | String | N | Y | Y | N | N |
The name of the role. |
title | String | N | Y | Y * | N | N |
The location of a role. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@href | String(URI) | Y | Y | N | Link to an external apiAccessProfile. Hyperlink Template: /api/space/user-management/api-access-profiles/{*ID}. |
id | Integer | Y | Y | N | Id of the api access profile. |
name | String | N | Y | Y * | Name of the api access profile. |
description | String | N | Y | Y * | Description for the api access profile. |
exec-rpc-rules | profile. | N | Y | Y |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this rpcRules node in the current node context. |
exec-rpc-rule | profile. | N | Y | Y * |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | N | Link to this aPIRPCRule node in the current node context. |
rule | String | N | Y | Y * | N | N | RPC restriction rule. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this domains node in the current node context. Hyperlink Template: /api/space/user-management/remote-profiles/{*ID}/domains. |
domain | profile. | N | Y | Y * |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | N | Link to this domain node in the current node context. Hyperlink Template: /api/space/domain-management/domains/{*ID}. |
@href | String(URI) | N | Y | Y * | N | N | Link to an external domain. Hyperlink Template: /api/space/domain-management/domains/{*ID}. |
id | Integer | Y | Y | N | N | N | Domain ID. |
name | String | Y | Y | N | Y | Y | Domain Name. |
Field Name | Type | Read Only | GET | PUT / POST | Description | ||||||
---|---|---|---|---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this profile-ref node in the current node context. Hyperlink Template: /api/space/domain-management/domains/{*ID}/profiles/{*ID}. |
||||||
@href | String(URI) | N | Y | Y * | Link to an external profile-ref. Hyperlink Template: /api/space/user-management/profiles/{*ID}. |
||||||
role-type | enum(role-type) | N | Y | Y * | Possible Values:
Default: ALL_ACCESS. |
||||||
domains | profile-ref. | N | Y | Y * | |||||||
id | Integer | Y | Y | N | |||||||
name | String | N | Y | Y |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this domains node in the current node context. Hyperlink Template: /api/space/domain-management/domains/{*ID}/profiles/{*ID}/domains. |
domain | profile-ref. | N | Y | Y * |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | N | Link to this domain node in the current node context. Hyperlink Template: /api/space/domain-management/domains/{*ID}/profiles/{*ID}/domains/{*ID}. |
@href | String(URI) | N | Y | Y * | N | N | Link to an external domain. Hyperlink Template: /api/space/domain-management/domains/{*ID}. |
id | Integer | Y | Y | N | N | N | |
name | String | N | Y | Y | N | N |
Field Name | Type | Read Only | GET | PUT / POST | PATCH | Description |
---|---|---|---|---|---|---|
@uri | String(URI) | N | Y | Y * | N | Link to this profiles node in the current node context. |
@size | Integer | N | Y | Y * | N |
A link to identify the 'profiles' resource. |
profile | profiles. | N | Y | Y * | Y | A single remote profile. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description | ||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
key | Integer | N | Y | Y | N | N |
A unique identifier for the user. |
||||||
name | String | N | Y | Y | Y | Y |
The name of the user. |
||||||
description | String | N | Y | Y | Y | Y |
A description of the user. |
||||||
uri | String | N | Y | Y | N | N |
A link to identify the 'user' resource. |
||||||
viewAllObjects | boolean | N | Y | Y | N | N | User can view all jobs or user's own jobs in job manager | ||||||
read-only | Boolean | N | Y | Y | Y | Y | A flag that indicates whether the remote profile is read-only. |
||||||
href | String | N | Y | Y | N | N |
The location of the 'user' resource. |
||||||
roleType | enum(roleType) | N | Y | Y | N | N | The role type, which is 'RemoteProfileRoleAccess'. Possible Values:
|
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | N | Y | Y | Link to this ptp node in the current node context. |
ctp | JSConnectionTerminationPoint[] | N | Y | Y | The collection of connection termination points for this PTP. |
type | String | N | Y | Y | The type of information |
encapsulation | String | N | Y | Y | The encapsulation of the PTP. |
tagging | String | N | Y | Y | Not supported |
adminStatus | String | N | Y | Y | The administration status |
operationStatus | String | N | Y | Y | The operation status of the termination point |
linkLevelType | String | N | Y | Y | The encapsulation being used on the physical interface. |
linkType | String | N | Y | Y | The type of link to the physical interface: full-duplex or half-duplex |
speed | Integer | N | Y | Y | The speed on the PTP |
speedStr | String | N | Y | Y | A string representation of the speed on the CTP |
mtu | Integer | N | Y | Y | The maximum transmission unit (MTU) size on the physical interface |
mtuStr | String | N | Y | Y | A string representation of the MTU on the CTP |
hardwarePhysicalAddress | String | N | Y | Y | The physical address of the hardware |
lacpBundle | String | N | Y | Y | The aggregated Ethernet interface to which this PTP belongs |
managed-element | ptp. | N | Y | Y * | Managed element parent for this PTP. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@href | String(URI) | N | Y | Y | Link to an external managedElementObj. |
id | Integer | N | Y | Y * | The ID of the managed element. |
ipAddr | String | N | Y | Y | The IP address of the managed element. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | N | Y | Y | Link to this ptp node in the current node context. |
ctp | JSConnectionTerminationPoint[] | N | Y | Y | The collection of connection termination points for this PTP. |
type | String | N | Y | Y | The 'information' type |
encapsulation | String | N | Y | Y | The encapsulation on the PTP. |
tagging | String | N | Y | Y | Not supported |
adminStatus | String | N | Y | Y | The administration status. |
operationStatus | String | N | Y | Y | The operation status of the termination point |
linkLevelType | String | N | Y | Y | The encapsulation being used on the physical interface |
linkType | String | N | Y | Y | The type of of link to the physical interface: full-duplex or half-duplex |
speed | Integer | N | Y | Y | The speed on the PTP. |
speedStr | String | N | Y | Y | A string representation of speed on the CTP |
mtu | Integer | N | Y | Y | The maximum transmission unit (MTU) size on the physical interface. |
mtuStr | String | N | Y | Y | A string representation of the MTU on the CTP |
hardwarePhysicalAddress | String | N | Y | Y | The physical address of the hardware |
lacpBundle | String | N | Y | Y | The aggregated Ethernet interface to which this PTP belongs |
managed-element | ptp. | N | Y | Y * | The information about a managed object. |
customized-attributes | view-manage-labels | N | Y | Y * | The managed labels for this PTP. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@href | String(URI) | N | Y | Y | Link to an external managedElementObj. |
id | Integer | N | Y | Y * | The ID of the managed element. |
ipAddr | String | N | Y | Y | IP address of the managed element. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@uri | String(URI) | N | Y | Y | N | N | Link to this ptp-ref node in the current node context. |
@href | String(URI) | N | Y | Y | N | N | Link to an external ptp-ref. |
type | String | N | Y | Y | N | N | The type of information |
encapsulation | String | N | Y | Y | N | N | The encapsulation of the PTP |
tagging | String | N | Y | Y | N | N | Not supported |
adminStatus | String | N | Y | Y | N | N | The administration status |
operationStatus | String | N | Y | Y | N | N | The operation status of the termination point |
linkLevelType | String | N | Y | Y | N | N | The encapsulation being used on the physical interface |
linkType | String | N | Y | Y | N | N |
The type of link to the physical interface : full-duplex or half-duplex. |
speed | Integer | N | Y | Y | N | N | The speed at the PTP |
speedStr | String | N | Y | Y | N | N | String representation of the speed on the CTP |
mtu | Integer | N | Y | Y | N | N | Maximum transmission unit (MTU) size on the physical interface |
mtuStr | String | N | Y | Y | N | N | A string representation of the MTU on the CTP |
hardwarePhysicalAddress | String | N | Y | Y | N | N | The physical address of the hardware |
lacpBundle | String | N | Y | Y | N | N | The aggregated Ethernet interface to which this PTP belongs |
managed-element | ptp-ref. | N | Y | Y * | N | N | Managed element parent for this PTP. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@href | String(URI) | N | Y | Y | Link to an external managedElementDTO. |
id | Integer | N | Y | Y * | The ID of the managed element |
ipAddr | String | N | Y | Y | The IP address of the managed element |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | N | Y | Y | Link to this ptps node in the current node context. |
@size | Integer | N | Y | Y | Size of the collection. |
ptp | ptps. | N | Y | Y | Collection of physical termination points (PTPs). |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@uri | String(URI) | N | Y | Y | N | N | Link to this physicalTerminationPoint node in the current node context. |
@href | String(URI) | N | Y | Y | N | N | Link to an external physicalTerminationPoint. |
@key | Integer | N | Y | Y * | N | N | ID of the PTP |
name | String | N | Y | Y | N | N | Name of the PTP |
type | String | N | Y | Y | N | N | Type of information. |
encapsulation | String | N | Y | Y | N | N | Encapsulation of the PTP. |
tagging | String | N | Y | Y | N | N | Not supported |
adminStatus | String | N | Y | Y | N | N | Administration status of the PTP |
operationStatus | String | N | Y | Y | N | N | Operational status of the termination point |
speed | Integer | N | Y | Y | N | N | Speed on the termination point |
mtu | Integer | N | Y | Y | N | N | Maximum transmission unit (MTU) size on the physical interface |
lacpBundle | String | N | Y | Y | N | N | Aggregated Ethernet interface to which this PTP belongs |
deviceId | String | N | Y | Y | N | N | ID of the device on which the PTP exists |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this ptps node in the current node context. |
@total | Integer | Y | Y | N | Total number of ptps in the API result set. |
ptp | ptps. | N | Y | Y * | Collection of Physical Interfaces of the Device(s). |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | N | Link to this deviceInterfaceStatus node in the current node context. Hyperlink Template: /api/space/managed-domain/ptps/{*ID}. |
@href | String(URI) | Y | Y | N | N | N | Link to an external deviceInterfaceStatus. Hyperlink Template: /api/space/managed-domain/ptps/{*ID}. |
mtu | Integer | Y | Y | N | Y | Y | Mtu of the Physical Interface. |
ipv4-address | String | Y | Y | N | Y | Y | IPv4 address of the Physical Interface. |
hardware-physical-address | String | Y | Y | N | Y | Y | Hardware Physical Address. |
speed-string | String | Y | Y | N | Y | Y | Speed of the Physical Interface in string format. |
speed | Integer | Y | Y | N | Y | Y | Speed of the Physical Interface. |
ipv6-address | String | Y | Y | N | Y | Y | IPv6 address of the Physical Interface. |
admin-status | String | Y | Y | N | Y | Y | Admin Status of the Physical Interface. |
operation-status | String | Y | Y | N | Y | Y | Operation Status of the Physical Interface. |
ipv6-addresses | String | Y | Y | N | Y | Y | IPv6 addresses of the Device. |
link-type | String | Y | Y | N | Y | Y | Link Type of the Physical Interface. |
interface-index | Integer | Y | Y | N | Y | Y | Interface Index of the Physical Interface. Default: 0. |
domain-name | String | Y | Y | N | Y | Y | Name of the Domain to which the Device belongs to. |
id | Integer | Y | Y | N | Y | Y | Unique ID of the Physical Interface. |
link-level-type | String | Y | Y | N | Y | Y | Link Level Type of the Physical Interface. |
device-name | String | Y | Y | N | Y | Y | Name of the Device. |
description | String | Y | Y | N | Y | Y | Description of the Physical Interface. |
domain-id | Integer | Y | Y | N | Y | Y | Unique ID of the Physical Interface. |
name | String | Y | Y | N | Y | Y | Name of the Physical Interface. |
mtu-string | String | Y | Y | N | Y | Y | Mtu of the Physical Interface in string format. |
device-id | Integer | Y | Y | N | Y | Y | Unique ID of the Device. |
ipv4-addresses | String | N | Y | Y | Y | Y | IPv4 addresses of the Device. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | N | Y | Y | Link to this ptps-ref node in the current node context. |
@size | Integer | N | Y | Y | The size of the collection |
ptp | ptps-ref. | N | Y | Y | A collection of physical termination points |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@href | String(URI) | N | Y | Y | N | N | Link to an external physicalTerminationPoint. |
@uri | String(URI) | N | Y | Y | N | N | Link to this physicalTerminationPoint node in the current node context. |
@key | Integer | N | Y | Y * | N | N | The ID of the PTP |
name | String | N | Y | Y | N | N | The name of the PTP |
type | String | N | Y | Y | N | N | The type of information |
encapsulation | String | N | Y | Y | N | N | The encapsulation of the PTP |
tagging | String | N | Y | Y | N | N | Not supported |
adminStatus | String | N | Y | Y | N | N | The administration status of the PTP |
operationStatus | String | N | Y | Y | N | N | The operational status of the termination point |
speed | Integer | N | Y | Y | N | N | The speed of the termination point. |
mtu | Integer | N | Y | Y | N | N | The maximum transmission unit (MTU) size on the physical interface |
lacpBundle | String | N | Y | Y | N | N | The aggregated Ethernet interface to which this PTP belongs |
deviceId | String | N | Y | Y | N | N | The ID of the device on which the PTP exist |
id | Integer | N | Y | Y * | N | N | The ID of the managed element |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
configuration-to-push | push-configuration-request. | N | Y | Y * | |
space-based-device-lock | Boolean | N | Y | Y * | Space Based Device Lock. Default: true. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this configurationToPushs node in the current node context. |
device-config-mapping | push-configuration-request. | N | Y | Y * |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | N | Link to this deviceConfigMapping node in the current node context. |
configs | push-configuration-request. | N | Y | Y * | N | N | |
device-id | Integer | N | Y | Y * | N | N | Device ID. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this configs node in the current node context. |
@total | Integer | Y | Y | N | Total number of gen_push-configuration-request-configuration-to-pushs-configuration-to-pushs-configs in the API result set. |
config | String[] | N | Y | Y * | Configs. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this raw-cli-configuration node in the current node context. |
*id | Integer | Y | Y | N | DeviceConfiguration ID. |
configuration | String | Y | Y | N | Configuration. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
xpath-list | raw-cli-configuration-request. | N | Y | Y | xpath list. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this xpathLists node in the current node context. |
xpath | String[] | N | Y | Y * | Xpath for which the configuration will be fetched. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
configuration | String | N | Y | Y * |
The configuration string. |
id | Integer | N | Y | Y |
A unique identifier for the raw configuration. |
method | String | N | Y | Y |
This represents a link to a POST method that is used to match the content of the configuration. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
configuration | String | N | Y | Y * |
The configuration string. |
id | Integer | N | Y | Y |
Unique identifier for the raw configuration. |
method | String | N | Y | Y |
This represent a link to a POST method that is used to match the content of the configuration. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this raw-xml-configuration node in the current node context. |
*id | Integer | Y | Y | N | DeviceConfiguration ID. |
configuration | String | Y | Y | N | Configuration. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
xpath-list | raw-xml-configuration-request. | N | Y | Y | Xpath list. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this xpathLists node in the current node context. |
xpath | String[] | N | Y | Y * | Xpath for which the configuration will be fetched. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
jobs | reassign-jobs-request. | N | Y | Y * |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this instanceManagedObjects node in the current node context. |
job | reassign-jobs-request. | N | Y | Y * |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@href | String(URI) | N | Y | Y * | N | N | Link to an external monitorableTaskInstanceManagedObject. Hyperlink Template: /api/space/job-management/jobs/{*ID}. |
id | Integer | Y | Y | N | Y | Y | The ID of the job. |
name | String | Y | Y | N | N | N | MonitorableTaskInstanceManagedObject Name. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this reboot-devices-job-results node in the current node context. |
@total | Integer | Y | Y | N | Total number of reboot-devices-job-results in the API result set. |
reboot-device-job-result | reboot-devices-job-results. | N | Y | Y * | Reboot Device Job Result Entry. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description | ||||
---|---|---|---|---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | N | Link to this rebootDeviceResult node in the current node context. |
||||
reboot-device-status | enum(reboot-device-status) | N | Y | Y * | Y | Y | Reboot device status. Possible Values:
|
||||
id | Integer | Y | Y | N | N | N | Job result table row ID. |
||||
device | reboot-devices-job-results. | N | Y | Y * | N | N | |||||
hostname | String | N | Y | Y | Y | Y | Hostname. |
||||
reboot-fail-reason | String | N | Y | Y * | Y | N | If device Reboot failed, set the fail reason. |
||||
device-id | Integer | N | Y | Y * | Y | Y | device id. |
||||
ip | String | N | Y | Y | Y | N | ip address. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@href | String(URI) | N | Y | Y * | Link to an external device. Hyperlink Template: /api/space/managed-domain/devices-require-polling/{*ID}. |
id | Integer | Y | Y | N | Device ID. |
name | String | Y | Y | N | Device Name. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this reboot-devices-request node in the current node context. |
message | String | N | Y | Y * | Power Off Message. |
power-off | Boolean | N | Y | Y * | Power Off. Default: false. |
lsys-label-toggle | Boolean | N | Y | Y * | Lsys Label Toggle. |
devices | reboot-devices-request. | N | Y | Y * | Devices to be rebooted. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this devices node in the current node context. Hyperlink Template: /devices. |
device | reboot-devices-request. | N | Y | Y * | Device to be Rebooted. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@href | String(URI) | N | Y | Y * | N | N | Link to an external device. Hyperlink Template: /api/space/device-management/devices/{*ID}. |
id | Integer | Y | Y | N | Y | Y | Device ID. |
name | String | Y | Y | N | Y | Y | Device Name. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
devices | resolve-key-conflict-request. | N | Y | Y * | Collection of Devices for which the Key Conflict to be resolved. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this credentialsBeans node in the current node context. |
device | resolve-key-conflict-request. | N | Y | Y * | Device for which the Key Conflict to be resolved. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | N | Link to this deviceCredentialsBean node in the current node context. |
ip-address | String | N | Y | Y * | N | N | IP Address of the Device for which the Key Conflict to be resolved. |
user-name | String | N | Y | Y * | N | N | Device User for which the Key Conflict to be resolved. |
password | String | N | Y | Y * | N | N | Password of the Device for which the Key Conflict to be resolved. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this resync-devices-job-results node in the current node context. |
@total | Integer | Y | Y | N | Total number of resync-devices-job-results in the API result set. |
resync-device-job-result | resync-devices-job-results. | N | Y | Y * | Resync Device Job Result Entry. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description | ||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | N | Link to this resyncDeviceResult node in the current node context. |
||||||
id | Integer | Y | Y | N | N | N | Job result table row ID. |
||||||
job-id | Integer | N | Y | Y * | N | N | Job ID. |
||||||
resync-type | enum(resync-type) | N | Y | Y | N | N | Resync Type. Possible Values:
|
||||||
resync-fail-reason | String | N | Y | Y * | Y | N | If device resync failed, set the fail reason. |
||||||
device | resync-devices-job-results. | N | Y | Y * | N | N | Device Object. |
||||||
hostname | String | N | Y | Y | Y | Y | Hostname. |
||||||
device-id | Integer | N | Y | Y * | Y | Y | device id. |
||||||
resync-device-status | enum(resync-device-status) | N | Y | Y * | Y | Y | Resync device status. Possible Values:
|
||||||
ip | String | N | Y | Y | Y | N | ip address. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@href | String(URI) | N | Y | Y * | Link to an external device. Hyperlink Template: /api/space/managed-domain/devices-require-polling/{*ID}. |
id | Integer | Y | Y | N | Device ID. |
name | String | Y | Y | N | Device Name. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
devices | resync-devices-request. | N | Y | Y * | Devices to be Resynchronized. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this deviceLists node in the current node context. |
device | resync-devices-request. | N | Y | Y * | Device to be Deleted. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@href | String(URI) | N | Y | Y * | N | N | Link to an external device. Hyperlink Template: /api/space/device-management/devices/{*ID}. |
id | Integer | Y | Y | N | Y | Y | Device ID. |
name | String | Y | Y | N | Y | Y | Device Name. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
devices | retry-deploy-configuration-request. | N | Y | Y * | Collection of device objects. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this devices node in the current node context. |
device | retry-deploy-configuration-request. | N | Y | Y * |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@href | String(URI) | N | Y | Y * | N | N | Link to an external device. Hyperlink Template: /api/space/device-management/devices/{*ID}. |
id | Integer | Y | Y | N | Y | Y | Device ID. |
name | String | Y | Y | N | Y | Y | Device Name. |
Field Name | Type | Read Only | GET | PUT / POST | PATCH | Description |
---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | Link to this role node in the current node context. Hyperlink Template: /api/space/user-management/roles/{*ID}. |
@href | String(URI) | Y | Y | N | N | Link to an external role. Hyperlink Template: /api/space/user-management/roles/{*ID}. |
id | Integer | Y | Y | N | N | Role ID. |
name | String | Y | Y | N | N | Role Name. |
title | String | N | Y | Y * | Y | Role Title. |
description | String | N | Y | Y | Y | Role Description. |
predefined | Boolean | Y | Y | N | N | Is this a predefined role? If false, then it's a custom role. Default: false. |
sharable | Boolean | Y | Y | N | N | Sharable. |
less-tasks | String | N | Y | Y | Y | Less Tasks. |
capabilities | role. | N | Y | Y * | Y | Capabilities. |
tasks | String | Y | Y | N | N | Tasks associated with this role Hyperlink Template: /api/space/user-management/roles/{*ID}/tasks. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this caps node in the current node context. Hyperlink Template: /api/space/user-management/roles/{*ID}/capabilities. |
capability | role. | N | Y | Y * | Single capability for a role. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | N | Link to this capability node in the current node context. Hyperlink Template: /api/space/user-management/roles/{*ID}/capabilities/{*ID}. |
@href | String(URI) | N | Y | Y * | N | N | Link to an external capability. Hyperlink Template: /api/space/user-management/capabilities/{*ID}. |
id | Integer | Y | Y | N | N | N | Capability ID. |
name | String | Y | Y | N | N | N | Capability Name. |
title | String | Y | Y | N | N | N | Capability Title. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@key | Integer | N | Y | Y * |
A unique identifier for the role. |
@href | String(URI) | N | Y | Y * | Link to an external role-ref. |
@uri | String(URI) | N | Y | Y * | Link to this role-ref node in the current node context. |
name | String | N | Y | Y * |
The name of the role. |
title | String | N | Y | Y |
The title of the role. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@key | Integer | N | Y | Y * |
The unique identifier for the role. |
@href | String(URI) | N | Y | Y * | Link to an external role-ref. |
@uri | String(URI) | N | Y | Y * | Link to this role-ref node in the current node context. |
name | String | N | Y | Y * |
The name of the role. |
title | String | N | Y | Y |
The title of the role. |
Field Name | Type | Read Only | GET | PUT / POST | PATCH | Description |
---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | Link to this roles node in the current node context. |
@total | Integer | Y | Y | N | N | Total number of roles in the API result set. |
role | roles. | N | Y | Y * | Y | A single role. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | N | Link to this role node in the current node context. Hyperlink Template: /api/space/user-management/roles/{*ID}. |
@href | String(URI) | Y | Y | N | N | N | Link to an external role. Hyperlink Template: /api/space/user-management/roles/{*ID}. |
id | Integer | Y | Y | N | Y | Y | Role ID. |
description | String | N | Y | Y | Y | Y | Role Description. |
name | String | N | Y | Y | N | N | Role Name. |
title | String | N | Y | Y | Y | Y | Role Title. |
predefined | Boolean | Y | Y | N | Y | Y | Is this a predefined role? If false, then it's a custom role. Default: false. |
less-tasks | String | N | Y | Y | N | N | Less Tasks. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | N | Y | Y | Link to this roles-ref node in the current node context. |
@size | Integer | N | Y | Y |
The total number of roles associated with a user. |
role | roles-ref. | N | Y | Y * |
The collection of objects of type 'userRole'. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@key | Integer | N | Y | Y | N | N |
A unique identifier for the role. |
@href | String(URI) | N | Y | Y | N | N | Link to an external roleRef. |
@uri | String(URI) | N | Y | Y | N | N | Link to this roleRef node in the current node context. |
id | Integer | N | Y | Y | N | N |
The role ID. |
name | String | N | Y | Y | N | N |
The name of the role. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | N | Y | Y | Link to this roles-ref node in the current node context. |
@size | Integer | N | Y | Y |
The total number of roles associated with a user. |
role | roles-ref. | N | Y | Y * |
The collection of objects of type 'userRole'. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@key | Integer | N | Y | Y | N | N |
A unique identifier for the role. |
@href | String(URI) | N | Y | Y | N | N | Link to an external userRole. |
@uri | String(URI) | N | Y | Y | N | N | Link to this userRole node in the current node context. |
id | Integer | N | Y | Y | N | N | The role ID |
name | String | N | Y | Y | N | N |
The name of the role. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@uri | String(URI) | N | Y | Y | N | N | Link to this routing-engine node in the current node context. |
ptp | ptp-ref[] | N | Y | Y | N | N | A collection of PTPs in this equipment |
supportingEquipment | routing-engine[] | N | Y | Y | N | N | All supported equipment for this equipment |
name | String | N | Y | Y | N | N | The name of the equipment |
expectedEquipmentObjectType | String | N | Y | Y | N | N |
The type of the expected equipment. |
installedEquipmentObjectType | String | N | Y | Y | N | N | The type of installed equipment. |
installedModel | String | N | Y | Y | N | N | The model of the installed equipment. |
installedPartNumber | String | N | Y | Y | N | N | The vendor's part number for the installed equipment |
installedSerialNumber | String | N | Y | Y | N | N |
The vendor's serial number for the installed equipment. |
manufacturer | String | N | Y | Y | N | N | The name of the equipment vendor |
installedVersion | String | N | Y | Y | N | N | The vendor's version identifier for the installed equipment |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | N | Y | Y | Link to this routing-engines node in the current node context. |
@size | Integer | N | Y | Y | Size of the collection |
equipment | routing-engines. | N | Y | Y |
Represents the collection of equipment for a managed element. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@key | String | N | Y | Y * | N | N | Serial number of the equipment |
@uri | String(URI) | N | Y | Y | N | N | Link to this equipment node in the current node context. |
id | Integer | N | Y | Y * | N | N | ID of the managed element |
name | String | N | Y | Y | N | N | Name of the equipment |
expectedEquipmentObjectType | String | N | Y | Y | N | N | An attribute that identifies the type of the expected resource |
installedEquipmentObjectType | String | N | Y | Y | N | N | An attribute that identifies the type of the installed resource |
installedModel | String | N | Y | Y | N | N | An attribute that identifies the type of the installed resource |
installedPartNumber | String | N | Y | Y | N | N |
An attribute that identifies the resource part number (PN) of the
installed equipment. |
installedVendorPartNumber | String | N | Y | Y | N | N |
An attribute that identifies the resource vendor part number (VPN) of the
installed equipment. |
installedVendorMaterialNumber | String | N | Y | Y | N | N |
An attribute that identifies the resource vendor material number (VMN) of the
installed equipment. |
installedVersion | String | N | Y | Y | N | N | An attribute that identifies the resource version of the installed
equipment. |
installedDescription | String | N | Y | Y | N | N | Description of the installation |
manufacturer | String | N | Y | Y | N | N | Name of equipment manufacturer |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | N | Y | Y | Link to this routing-instances node in the current node context. |
@size | Integer | N | Y | Y | The size of the collection |
routing-instance | routing-instances. | N | Y | Y | A collection of all routing instances for a managed element. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
routeDistinguisher | String | N | Y | Y | N | N | A unique route distinguisher that is associated with this routing instance. |
vlanTagsInner | String | N | Y | Y | N | N | The inner VLAN tag |
vlanTagsOuter | String | N | Y | Y | N | N | The outer VLAN tag |
vrfTargetImport | String | N | Y | Y | N | N | The community name of the import target for the VPN routing and forwarding instance |
vrfTargetExport | String | N | Y | Y | N | N | The community name of the export target for the VPN routing and forwarding instance |
id | Integer | N | Y | Y * | N | N | The ID of the route. |
name | String | N | Y | Y | N | N | The name of the route |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | N | Y | Y | Link to this routing-options node in the current node context. |
id | Integer | N | Y | Y * | The ID of the resource. |
name | String | N | Y | Y | The name of the resource. |
autonomousSystem | long | N | Y | Y | The autonomous system ID. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
status | String | N | Y | Y | The status of the executed RPC command |
data | String | N | Y | Y | The data of the executed RPC command |
description | String | N | Y | Y | Description of the executed RPC command |
devId | Integer | N | Y | Y | The devId of the executed RPC command |
channelId | Integer | N | Y | Y | The channel ID of the executed RPC command |
rpcCommands | RpcCommands | N | Y | Y * | Complex type of the RPC command |
commitComment | String | N | Y | Y | The commit comment of the executed RPC command |
netConfReplies | NetConfReplies | N | Y | Y | The netconf replies for the executed command |
configuration | String | N | Y | Y | The configuration of executed RPC command |
deviceFamily | String | N | Y | Y | The device family |
isCluster | Boolean | N | Y | Y | Cluster mode |
enableDiscardChanges | Boolean | N | Y | Y | Enable discard changes for netconf |
netconfConfirmedCommit | Boolean | N | Y | Y | Netconf confirmed commit |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
status | String | N | Y | Y | The status of the executed RPC command |
data | String | N | Y | Y | The data of the executed RPC command |
description | String | N | Y | Y | The description of the executed RPC command |
devId | Integer | N | Y | Y | The devId of the executed RPC command |
channelId | Integer | N | Y | Y | The channel ID of the executed RPC command |
rpcCommands | RpcCommands | N | Y | Y * | Complex type of the RPC command |
commitComment | String | N | Y | Y | The commit comment of the executed RPC command |
netConfReplies | NetConfReplies | N | Y | Y | The netconf replies for the executed command |
configuration | String | N | Y | Y | The configuration of the executed RPC command |
deviceFamily | String | N | Y | Y | The device family |
isCluster | Boolean | N | Y | Y | Cluster mode |
enableDiscardChanges | Boolean | N | Y | Y | Enable discard changes for netconf |
netconfConfirmedCommit | Boolean | N | Y | Y | Netconf confirmed commit |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this rsa-key-transfer-job-results node in the current node context. |
@total | Integer | Y | Y | N | Total number of rsa-key-transfer-job-results in the API result set. |
rsa-key-transfer-job-result | rsa-key-transfer-job-results. | N | Y | Y * | RSA key Transfer Job Result. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | N | Link to this rSAKeyTransferJobResult node in the current node context. |
id | Integer | Y | Y | N | N | N | Job result table row ID. |
space-user-name | String | N | Y | Y * | Y | Y | Space User Name. |
status | String | N | Y | Y * | Y | N | Status. |
description | String | N | Y | Y * | Y | N | Description. |
host-name | String | N | Y | Y | Y | Y | Host Name. |
device-address | String | N | Y | Y * | Y | N | Device Address. |
job-instance-id | Integer | N | Y | Y * | Y | N | Job Instance ID. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this schedule-purging-job-request node in the current node context. |
category-ids | schedule-purging-job-request. | N | Y | Y * | |
ipaddress | String | N | Y | Y * | Ipaddress. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this categoryIds node in the current node context. |
category-id | String[] | N | Y | Y * | Category Ids. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this schemas node in the current node context. |
@total | Integer | Y | Y | N | Total number of schemas in the API result set. |
schema | schemas. | N | Y | Y * |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | N | Link to this schema node in the current node context. Hyperlink Template: /api/space/schema-serviceupload-tgz-schema-file. |
device-family | String | N | Y | Y * | N | N | Device Family. |
schema-location | String | N | Y | Y * | N | N | Schema Location. |
release | String | N | Y | Y * | N | N | Release. |
Field Name | Type | Read Only | GET | PUT / POST | Description | ||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
@uri | String(URI) | N | Y | Y | Link to this script node in the current node context. |
||||||||
id | String | N | Y | Y | A unique identifier for the script | ||||||||
scriptName | String | N | Y | Y |
The name of the script. |
||||||||
category | String | N | Y | Y |
Category of the script. |
||||||||
domain-name | String | N | Y | Y | |||||||||
domain-id | Integer | N | Y | Y | |||||||||
type | enum(type) | N | Y | Y |
The type of the script
Possible Values:
|
||||||||
format | enum(format) | N | Y | Y |
The format of the script
Possible Values:
|
||||||||
lastestRevision | String | N | Y | Y |
The version of the script. |
||||||||
comments | String | N | Y | Y |
A description of the script. |
||||||||
scriptSize | Long | N | Y | Y |
The size of script in bytes. |
||||||||
completionStatus | enum(completionStatus) | N | Y | Y |
The import status of the script
Possible Values:
|
||||||||
destFileName | String | N | Y | Y | The destination file name for the script | ||||||||
revisionsAvailable | String | N | Y | Y |
The revisions available for the script. |
||||||||
scriptContents | String | N | Y | Y |
The contents of the script. |
||||||||
domain | String | Y | Y | N | |||||||||
collection | String | N | Y | Y | The location of the different resources | ||||||||
contents | String | N | Y | Y | The location of the 'contents' resource | ||||||||
parameters | String | N | Y | Y | The location of the 'parameters' resource | ||||||||
view-associated-devices | String | N | Y | Y |
The association of the script to the devices. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this script-mgmt-job-results node in the current node context. |
@total | Integer | Y | Y | N | Total number of script-mgmt-job-results in the API result set. |
script-mgmt-job-result | script-mgmt-job-results. | N | Y | Y * |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description | ||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | N | Link to this scriptMgmtJobResult node in the current node context. |
||||||||||||||||||||||
id | Integer | Y | Y | N | N | N | Job result table row ID. |
||||||||||||||||||||||
script-params | String | Y | Y | N | N | N | |||||||||||||||||||||||
action-url | String | Y | Y | N | N | N | |||||||||||||||||||||||
job-status | String | Y | Y | N | N | N | |||||||||||||||||||||||
enable-auto-upgrade | Boolean | Y | Y | N | N | N | |||||||||||||||||||||||
job-id | Integer | Y | Y | N | N | N | |||||||||||||||||||||||
script-id | Integer | Y | Y | N | Y | Y | |||||||||||||||||||||||
rule-data | String | Y | Y | N | N | N | |||||||||||||||||||||||
context | String | Y | Y | N | N | N | |||||||||||||||||||||||
job-remarks | String | Y | Y | N | Y | Y | |||||||||||||||||||||||
sequence | Integer | Y | Y | N | N | N | |||||||||||||||||||||||
script-version | String | Y | Y | N | Y | Y | |||||||||||||||||||||||
rule-type | String | Y | Y | N | N | N | |||||||||||||||||||||||
ip | String | Y | Y | N | Y | Y | |||||||||||||||||||||||
action-type | enum(action-type) | Y | Y | N | N | N | Possible Values:
|
||||||||||||||||||||||
hostname | String | Y | Y | N | Y | Y | |||||||||||||||||||||||
script-enable | Boolean | Y | Y | N | N | N | Default: true. |
||||||||||||||||||||||
script-type | enum(script-type) | Y | Y | N | Y | Y | Possible Values:
|
||||||||||||||||||||||
script-mgmt-job-status | enum(script-mgmt-job-status) | Y | Y | N | Y | Y | Possible Values:
|
||||||||||||||||||||||
script-name | String | Y | Y | N | Y | Y | |||||||||||||||||||||||
category | String | Y | Y | N | Y | Y | Category
Category is an arbitrary value used for sorting/filtering. |
||||||||||||||||||||||
device-id | Integer | Y | Y | N | N | N | |||||||||||||||||||||||
associated-tag-list | String | Y | Y | N | N | N | |||||||||||||||||||||||
local-script-response | String | Y | Y | N | N | N | |||||||||||||||||||||||
on-close-string | String | Y | Y | N | N | N | |||||||||||||||||||||||
script-bundle-id | Integer | Y | Y | N | N | N | |||||||||||||||||||||||
device-name | String | Y | Y | N | Y | Y | |||||||||||||||||||||||
script-status | String | Y | Y | N | N | N | |||||||||||||||||||||||
device | String | Y | Y | N | N | N | Device Link. |
||||||||||||||||||||||
job | String | Y | Y | N | N | N | |||||||||||||||||||||||
script | String | Y | Y | N | N | N | Script Link. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this scripts node in the current node context. |
@total | Integer | Y | Y | N | Total number of scripts in the API result set. |
script | scripts. | N | Y | Y * |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | N | Link to this script node in the current node context. Hyperlink Template: /api/space/script-management/scripts/{*ID}. |
@href | String(URI) | Y | Y | N | N | N | Link to an external script. Hyperlink Template: /api/space/script-management/scripts/{*ID}. |
id | Integer | Y | Y | N | Y | Y | Script ID. |
scriptName | String | N | Y | Y * | Y | Y | Script Name. |
category | String | N | Y | Y | Y | Y | Category. |
domain-name | String | N | Y | Y | N | N | Domain Name. |
domain-id | Integer | N | Y | Y | N | Y | Domain ID. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | N | Y | Y | Link to this settings node in the current node context. |
user | String | N | Y | Y * |
Location of 'user' resource corresponding to user settings on Junos Space. |
device | String | N | Y | Y * |
Location of 'device' resource corresponding to device settings on Junos Space. |
password | String | N | Y | Y * |
Location of 'password' resource corresponding to password settings on Junos Space. |
audit-log | String | N | Y | Y * |
Location of 'audit-log' resource corresponding to audit-log settings on Junos Space. |
domain | String | N | Y | Y * |
Location of 'domain' resource corresponding to domain settings on Junos Space. |
authmode | String | N | Y | Y * |
Location of 'authmode' resource corresponding to user->authmode settings on Junos Space. |
cli-configlet | String | N | Y | Y * | Cli-Configlet enable/disable Approval Workflow |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this smtp-server node in the current node context. Hyperlink Template: /api/space/smtp-management/smtp-servers/{*ID}. |
@href | String(URI) | Y | Y | N | Link to an external smtp-server. Hyperlink Template: /api/space/smtp-management/smtp-servers/{*ID}. |
*id | Integer | Y | Y | N | SmtpServer ID. |
name | String | N | Y | Y * | SmtpServer Name. |
ip-address | String | N | Y | Y * | IP Address. |
port | Integer | N | Y | Y * | Port. Default: 587. |
use-tls | Boolean | N | Y | Y * | Use TLS. Default: false. |
security-setting | String | N | Y | Y * | Security Setting. |
auth-password | String | N | Y | Y * | Auth Password. |
host-address | String | N | Y | Y * | Host Address. |
from-email-addr | String | N | Y | Y * | From Email Addr. |
domain-name | String | Y | Y | N | Domain Name. |
is-active | String | N | Y | Y * | Is Active. Default: "Yes". |
use-ssl | Boolean | N | Y | Y * | Use SSL. Default: false. |
auth-user | String | N | Y | Y * | Auth User. |
domain-id | Integer | N | Y | Y | Domain ID. |
user-auth | Boolean | N | Y | Y * | User Auth. Default: false. |
active-server | Boolean | N | Y | Y * | Active Server. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this smtp-servers node in the current node context. |
@total | Integer | Y | Y | N | Total number of smtp-servers in the API result set. |
smtp-server | smtp-servers. | N | Y | Y * |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | N | Link to this smtpServer node in the current node context. Hyperlink Template: /api/space/smtp-management/smtp-servers/{*ID}. |
@href | String(URI) | Y | Y | N | N | N | Link to an external smtp-server. Hyperlink Template: /api/space/smtp-management/smtp-servers/{*ID}. |
id | Integer | Y | Y | N | N | N | SmtpServer ID. |
name | String | N | Y | Y * | Y | Y | SmtpServer Name. |
ip-address | String | N | Y | Y * | N | N | IP Address. |
port | Integer | N | Y | Y * | N | Y | Port. Default: 587. |
is-active | String | N | Y | Y * | N | Y | Is Active. Default: "Yes". |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | N | Y | Y | Link to this software-identities node in the current node context. |
@size | Integer | N | Y | Y | The size of the collection |
software-identity | software-identities. | N | Y | Y | A collection of software identities |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@key | Integer | N | Y | Y * | N | N | ID of the software |
name | String | N | Y | Y | N | N | The name of the software. |
majorVersion | Integer | N | Y | Y | N | N | The major version information |
minorVersion | Integer | N | Y | Y | N | N | The minor version information |
revisionNumber | Double | N | Y | Y | N | N | The software revision number, if any |
buildNumber | Integer | N | Y | Y | N | N | The build number of the software. |
deviceFamily | String | N | Y | Y | N | N | The device family associated with this software package |
softwareReleaseVersion | String | N | Y | Y | N | N | The device family to which the software belongs |
Classification | String | N | Y | Y | N | N | Classification information |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
taskid | Integer | N | Y | Y * | Enter the task ID. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
value | Boolean | N | Y | Y * | Output value. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this submit-cli-configlet-request node in the current node context. |
context | String | N | Y | Y | Context. |
cli-configlet-params | submit-cli-configlet-request. | N | Y | Y | |
devices | submit-cli-configlet-request. | N | Y | Y * |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this cliConfigletParams node in the current node context. Hyperlink Template: /cli-configlet-params. |
cli-configlet-param | submit-cli-configlet-request. | N | Y | Y * |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | N | Link to this configletParamForNBI node in the current node context. |
parameter | submit-cli-configlet-request. | Y | Y | N | N | N | |
parameter-value | String | Y | Y | N | N | N | Parameter Value. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@href | String(URI) | N | Y | Y * | Link to an external paramForNBI. Hyperlink Template: /api/space/configuration-management/cli-configlets/{*ID}/cli-configlet-params/{*ID}. |
param-id | Integer | Y | Y | N | Configlet parameter ID. |
name | String | Y | Y | N | Parameter Name. |
configlet-id | Integer | Y | Y | N | Configlet ID. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@href | String(URI) | N | Y | Y * | Link to an external device. Hyperlink Template: /api/space/device-management/devices/{*ID}. |
id | Integer | Y | Y | N | Device ID. |
name | String | Y | Y | N | Device Name. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this submit-cli-configlet-request node in the current node context. |
configlet | submit-cli-configlet-request. | N | Y | Y * | |
context | String | N | Y | Y * | Context. |
cli-configlet-params | submit-cli-configlet-request. | N | Y | Y |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@href | String(URI) | N | Y | Y * | Link to an external cliConfigurationTemplate. Hyperlink Template: /api/space/configuration-management/cli-templates/{*ID}. |
id | Integer | Y | Y | N | Configlet ID Unique key of the configlet. |
name | String | Y | Y | N | Configlet Name The name of the configlet and it cannot exceed 255 characters. You cannot have two configlets with the same name in one domain and if this configlet have to be included by other configlets via #mixin directive, then configlet name should not have SPACE and DOT(. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this cliConfigletParams node in the current node context. Hyperlink Template: /cli-configlet-params. |
cli-configlet-param | submit-cli-configlet-request. | N | Y | Y * |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | N | Link to this configletParamForNBI node in the current node context. |
parameter | submit-cli-configlet-request. | N | Y | Y | N | N | |
parameter-value | String | N | Y | Y | N | N | Parameter Value. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@href | String(URI) | N | Y | Y * | Link to an external paramForNBI. Hyperlink Template: /api/space/configuration-management/cli-configlets/{*ID}/cli-configlet-params/{*ID}. |
param-id | Integer | Y | Y | N | Configlet parameter ID. |
name | String | Y | Y | N | Parameter Name. |
configlet-id | Integer | Y | Y | N | Configlet ID. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
value | Integer | N | Y | Y * | Value. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
value | Integer | N | Y | Y * | Value. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this svn-request node in the current node context. |
svn-trunk-url | String | N | Y | Y * | Svn Trunk Url. |
svn-user-name | String | N | Y | Y * | Svn User Name. |
svn-user-password | String | N | Y | Y * | Svn User Password. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this svn-response node in the current node context. |
svn-trunk-url | String | N | Y | Y * | Svn Trunk Url. |
svn-user-name | String | N | Y | Y * | Svn User Name. |
svn-user-password | String | N | Y | Y * | Svn User Password. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | N | Y | Y | Link to this tag node in the current node context. |
id | Integer | N | Y | Y |
The ID of the tag object. |
name | String | N | Y | Y * |
The name of the tag object. |
type | String | N | Y | Y * |
The access type of the tag object. |
targets | tag. | N | Y | Y |
The access collection of targets tagged by a tag. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | N | Y | Y | Link to this targets node in the current node context. |
@href | String(URI) | N | Y | Y | Link to an external targets. |
target | tag. | N | Y | Y |
The collection of targets tagged by a tag. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@type | String | N | Y | Y | N | N |
The media type that can be used to access the target using an HREF attribute. |
@uri | String(URI) | N | Y | Y | N | N | Link to this target node in the current node context. |
@href | String(URI) | N | Y | Y * | N | N | Link to an external target. |
id | Integer | N | Y | Y | N | N | The target ID. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this tags node in the current node context. |
@total | Integer | Y | Y | N | Total number of tags in the API result set. |
tag | tags. | N | Y | Y * |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | N | Link to this tag node in the current node context. Hyperlink Template: /api/space/tag-management/tags/{*ID}. |
@href | String(URI) | N | Y | Y * | N | N | Link to an external tag. Hyperlink Template: /api/space/tag-management/tags/{*ID}. |
id | Integer | Y | Y | N | N | N | Tag ID. |
name | String | Y | Y | N | Y | Y | Tag Name. |
access-type | String | Y | Y | N | Y | Y | Access Type. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | N | Y | Y | Link to this tags node in the current node context. |
@size | Integer | N | Y | Y | The size of the tag collection |
tag | tags. | N | Y | Y | All tags inside the collection |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@uri | String(URI) | N | Y | Y | N | N | Link to this tag node in the current node context. |
@href | String(URI) | N | Y | Y | N | N | Link to an external tag. |
id | Integer | N | Y | Y * | N | N | The ID attribute of the tag |
name | String | N | Y | Y | Y | Y |
The name of the tag. |
type | String | N | Y | Y | N | N |
The access type of the tag. |
targets | tags. | N | Y | Y | N | N |
The access collection of targets tagged by a tag. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | N | Y | Y | Link to this targets node in the current node context. |
id | Integer | N | Y | Y | Tag ID. |
target | tags. | N | Y | Y |
The collection of targets tagged by a tag. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@type | String | N | Y | Y | N | N |
The media type that can be used to access the target using an HREF attribute. |
@uri | String(URI) | N | Y | Y | N | N | Link to this target node in the current node context. |
@href | String(URI) | N | Y | Y | N | N | Link to an external target. |
id | Integer | N | Y | Y | N | N | Target ID. |
tagId | Integer | N | Y | Y | N | N | Tag ID for this target. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@type | String | N | Y | Y |
The media type that can be used to access the target using an HREF attribute. |
@uri | String(URI) | N | Y | Y | Link to this target node in the current node context. |
@href | String(URI) | N | Y | Y * | Link to an external target. |
id | Integer | N | Y | Y | The target ID. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | N | Y | Y | Link to this targets node in the current node context. |
target | targets. | N | Y | Y * |
The collection of targets tagged by a tag. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@type | String | N | Y | Y | N | N |
The media type that can be used to access the target using an HREF attribute. |
@uri | String(URI) | N | Y | Y | N | N | Link to this target node in the current node context. |
@href | String(URI) | N | Y | Y * | N | N | Link to an external target. |
id | Integer | N | Y | Y | N | N | Target ID. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | N | Y | Y * | Link to this task node in the current node context. |
id | Integer | N | Y | Y |
The unique identifier for the task. |
name | String | N | Y | Y * |
The name of the task. |
title | String | N | Y | Y |
The title of the task. |
cls | String | N | Y | Y |
The CLS description of the task. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@href | String(URI) | N | Y | Y | Link to an external task. |
id | Integer | N | Y | Y * | ID of the Job which is running the Task. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this task-ref node in the current node context. Hyperlink Template: /api/space/user-management/roles/{*ID}/tasks/{*ID}. |
@href | String(URI) | N | Y | Y * | Link to an external task-ref. Hyperlink Template: /api/space/user-management/tasks/{*ID}. |
id | Integer | Y | Y | N | Task ID. |
name | String | Y | Y | N | Task Name. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@key | Integer | N | Y | Y * |
The unique identifier for the task. |
@href | String(URI) | N | Y | Y * | Link to an external task-ref. |
@uri | String(URI) | N | Y | Y * | Link to this task-ref node in the current node context. |
name | String | N | Y | Y * |
The name of the task. |
title | String | N | Y | Y |
The title of the task. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this task-refs node in the current node context. |
@total | Integer | Y | Y | N | Total number of tasks in the API result set. |
task | task-refs. | N | Y | Y * | Task. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | N | Link to this task node in the current node context. Hyperlink Template: /api/space/user-management/roles/{*ID}/tasks/{*ID}. |
@href | String(URI) | N | Y | Y * | N | N | Link to an external task. Hyperlink Template: /api/space/user-management/tasks/{*ID}. |
id | Integer | Y | Y | N | N | N | Task ID. |
name | String | Y | Y | N | N | N | Task Name. |
title | String | Y | Y | N | N | N | Title. |
capability-name | String | Y | Y | N | N | N | Capability Name. |
hidden-task | Boolean | Y | Y | N | N | N | Hidden Task. Default: false. |
workspace-name | String | Y | Y | N | N | N | Workspace Name. |
workspace-title | String | Y | Y | N | N | N | Workspace Title. |
module-name | String | Y | Y | N | N | N | Module Name. |
module-title | String | Y | Y | N | N | N | Module Title. |
parent-task-name | String | Y | Y | N | N | N | Parent Task Name. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | N | Y | Y * | Link to this tasks node in the current node context. |
@size | Integer | N | Y | Y * |
The total number of tasks available in the system. |
task | tasks. | N | Y | Y * |
The collection of objects of type 'task'. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
key | Integer | N | Y | Y | N | N |
A unique identifier for a task. |
name | String | N | Y | Y | N | N |
The name of the task. |
title | String | N | Y | Y | N | N | |
uri | String | N | Y | Y | N | N |
A link to identify the 'task' resource. |
href | String | N | Y | Y | N | N |
The location of a task. |
parent-task-name | String | N | Y | Y | N | N | |
workspace-name | String | N | Y | Y | N | N | |
workspace-title | String | N | Y | Y | N | N | |
module-name | String | N | Y | Y | N | N | |
module-title | String | N | Y | Y | N | N | |
capability-name | String | N | Y | Y | N | N | |
hidden-task | Boolean | N | Y | Y | N | N |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | N | Y | Y * | Link to this tasks-ref node in the current node context. |
@size | Integer | N | Y | Y |
The total number of tasks associated with a capability. |
task | tasks-ref. | N | Y | Y |
The collection of objects of type 'task'. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
key | Integer | N | Y | Y | N | N |
The unique identifier for the task. |
name | String | N | Y | Y | N | N |
The name of the task. |
href | String | N | Y | Y | N | N |
The location of a task. |
uri | String | N | Y | Y | N | N |
A link to identify the task associated with a capability. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this template-config-cli node in the current node context. Hyperlink Template: /api/space/config-template-management/config-templates/{*ID}/versions/{*ID}/configuration. |
@href | String(URI) | Y | Y | N | Link to an external template-config-cli. Hyperlink Template: /api/space/config-template-management/config-templates/{*ID}/versions/{*ID}/configuration. |
cli | String | Y | Y | N | Cli. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this template-config-cli node in the current node context. Hyperlink Template: /api/space/config-template-management/templates/{*ID}/template-config. |
@href | String(URI) | N | Y | Y * | Link to an external template-config-cli. Hyperlink Template: /api/space/config-template-management/config-templates/{*ID}/versions/{*ID}/configuration. |
cli | String | Y | Y | N | Cli. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this template-config-xml node in the current node context. Hyperlink Template: /api/space/config-template-management/config-templates/{*ID}/versions/{*ID}/configuration. |
@href | String(URI) | Y | Y | N | Link to an external template-config-xml. Hyperlink Template: /api/space/config-template-management/config-templates/{*ID}/versions/{*ID}/configuration. |
xml | String | Y | Y | N | Xml. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this template-config-xml node in the current node context. Hyperlink Template: /api/space/config-template-management/templates/{*ID}/template-config. |
@href | String(URI) | Y | Y | N | Link to an external template-config-xml. Hyperlink Template: /api/space/config-template-management/config-templates/{*ID}/versions/{*ID}/configuration. |
xml | String | N | Y | Y * | The content of the configuration template in XML. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this template-request-refs node in the current node context. |
@total | Integer | Y | Y | N | Total number of template-requests in the API result set. |
template-request | template-request-refs. | N | Y | Y * |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | N | Link to this templateRequest node in the current node context. Hyperlink Template: /api/space/config-template-management/templates/deploy-template-result/jobs/{*ID}/{*ID}. |
||||||||||
@href | String(URI) | N | Y | Y * | N | N | Link to an external templateRequest. Hyperlink Template: /api/space/config-template-management/template-requests-by-ids/{*ID}. |
||||||||||
id | Integer | Y | Y | N | N | N | TemplateRequest ID. |
||||||||||
device-id | Integer | Y | Y | N | N | N | Device ID. |
||||||||||
tr-id | Integer | Y | Y | N | N | N | Tr ID. |
||||||||||
cr-id | Integer | Y | Y | N | N | N | Cr ID. |
||||||||||
domain-name | String | Y | Y | N | N | N | Domain Name. |
||||||||||
domain-id | Integer | Y | Y | N | N | Y | Domain ID. |
||||||||||
status-name | String | Y | Y | N | Y | Y | Status Name. |
||||||||||
xml-data | String | Y | Y | N | N | N | Xml Data. |
||||||||||
status | enum(status) | Y | Y | N | Y | N | Status. Possible Values:
Default: NA. |
||||||||||
device-name | String | Y | Y | N | Y | N | Device Name. |
||||||||||
xml-data-reply | String | Y | Y | N | Y | N | Xml Data Reply. |
||||||||||
job-id | Integer | Y | Y | N | N | N | Job ID. |
||||||||||
device-ip | String | Y | Y | N | Y | N | Device IP. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this template-versions node in the current node context. |
@total | Integer | Y | Y | N | Total number of template-versions in the API result set. |
version | template-versions. | N | Y | Y * |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | N | Link to this version node in the current node context. Hyperlink Template: /api/space/config-template-management/templates/{*ID}/template-versions/{*ID}. |
@href | String(URI) | Y | Y | N | N | N | Link to an external version. Hyperlink Template: /api/space/config-template-management/templates/{*ID}/template-versions/{*ID}. |
content | String | N | Y | Y | N | N | Content. |
deploy-status | String | N | Y | Y | N | N | Deploy Status. |
modified-time | Date | N | Y | Y | N | N | Modified Time. |
number | String | N | Y | Y * | N | N | Number. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this terminate-user-session-job-results node in the current node context. |
@total | Integer | Y | Y | N | Total number of terminate-user-session-job-results in the API result set. |
terminate-user-session-job-result | terminate-user-session-job-results. | N | Y | Y * |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description | ||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | N | Link to this terminateUserSessionJobResult node in the current node context. |
||||||
job-id | Integer | Y | Y | N | N | N | Job ID. |
||||||
job-status | enum(job-status) | N | Y | Y * | N | N | Job Status. Possible Values:
|
||||||
active-user-id | String | N | Y | Y * | N | N | Active User Session ID. |
||||||
user-ip-addr | String | N | Y | Y * | N | N | User's IP Address. |
||||||
user-name | String | N | Y | Y * | N | N | User Name. |
||||||
job-description | String | N | Y | Y * | N | N | Job Description. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
active-user-sessions | terminate-user-sessions-request. | N | Y | Y * |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this activeUserLists node in the current node context. |
active-user-session | terminate-user-sessions-request. | N | Y | Y * |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@href | String(URI) | N | Y | Y * | N | N | Link to an external activeUser. Hyperlink Template: /api/space/user-management/active-user-sessions/{*ID}. |
id | Integer | Y | Y | N | N | N | ActiveUser ID. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this test-connection-request node in the current node context. |
svn-trunk-url | String | N | Y | Y * | Svn Trunk Url. |
svn-user-name | String | N | Y | Y * | Svn User Name. |
svn-user-password | String | N | Y | Y * | Svn User Password. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
value | Boolean | N | Y | Y * | Value. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
users | unlock-users-request. | N | Y | Y * |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this users node in the current node context. |
user | unlock-users-request. | N | Y | Y * | Get all users. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@href | String(URI) | N | Y | Y * | N | N | Link to an external user. Hyperlink Template: /api/space/user-management/users/{*ID}. |
id | Integer | Y | Y | N | Y | Y | User ID. |
name | String | Y | Y | N | Y | Y | User Name. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
devices | unmanaged-device-request. | N | Y | Y * |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this deviceDetailsses node in the current node context. |
device | unmanaged-device-request. | N | Y | Y * |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@href | String(URI) | Y | Y | N | N | N | Link to an external unManagedDeviceDetails. Hyperlink Template: /api/space/device-management/unmanaged-device-management/unmanaged-device-by-device-ids/{*ID}. |
password | String | N | Y | Y * | N | N | Password. |
domain-name | String | N | Y | Y | N | N | Domain Name. |
loopback-address | String | N | Y | Y | N | N | Loopback Address. |
snmp-v3-username | String | N | Y | Y | N | N | Snmp v3 Username. |
community | String | N | Y | Y | N | N | Community. |
vendor | String | N | Y | Y * | N | N | Vendor. |
snmp-v3-auth-type | String | N | Y | Y | N | N | Snmp v3 Auth Type. |
snmp-v1-v2-community | String | N | Y | Y | N | N | Snmp v1 v2 Community. |
snmp-v3-privacy-type | String | N | Y | Y | N | N | Snmp v3 Privacy Type. |
ip-address | String | N | Y | Y | N | N | IP Address. |
snmp-v3-auth-password | String | N | Y | Y | N | N | Snmp v3 Auth Password. |
snmp-version | String | N | Y | Y | N | N | Snmp Version. |
loopback-name | String | N | Y | Y | N | N | Loopback Name. |
hostname | String | N | Y | Y | N | N | Hostame. |
username | String | N | Y | Y * | N | N | Username. |
unreachable | Boolean | N | Y | Y | N | N | Unreachable. Default: true. |
snmp-v3-privacy-password | String | N | Y | Y | N | N | Snmp v3 Privacy Password. |
advanced-properties | unmanaged-device-request. | N | Y | Y | N | N |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this advancedProperties node in the current node context. |
@total | Integer | Y | Y | N | Total number of gen_unmanaged-device-request-device-detailsses-device-detailsses-advanced-properties in the API result set. |
unmanaged-device-attr | unmanaged-device-request. | N | Y | Y * |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | N | Link to this unmanagedDeviceAttr node in the current node context. |
value | String | N | Y | Y * | N | N | Value. |
key | String | N | Y | Y * | N | N | Key. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this unused-schemas node in the current node context. |
@total | Integer | Y | Y | N | Total number of unused-schemas in the API result set. |
dmi-schema-info | unused-schemas. | N | Y | Y * |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | N | Link to this dmiSchemaInfo node in the current node context. |
os-version | String | Y | Y | N | Y | N | Os Version. |
dev-family | String | Y | Y | N | Y | N | Dev Family. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
user-preference-state | update-user-preference-state-request. | N | Y | Y * | |
is-encode | Boolean | N | Y | Y * | Is Encode. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this updateUserPreferenceStateResponse node in the current node context. |
id | Integer | Y | Y | N | UserPreferenceState ID. |
state-name | String | N | Y | Y * | State Name. |
state-value | String | N | Y | Y * | State Value. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this update-user-preference-state-response node in the current node context. |
*id | Integer | Y | Y | N | UserPreferenceState ID. |
state-name | String | N | Y | Y * | State Name. |
state-value | String | N | Y | Y * | State Value. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this upload-image-response node in the current node context. |
image-id | Integer | Y | Y | N | Id created for the image, after uploading. |
image-name | String | N | Y | Y * | Name of the uploaded image. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
device-credentials-bean-list | upload-keys-request. | N | Y | Y * | Device Credentials for List of Device. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this deviceCredentialsBeanLists node in the current node context. |
device-credentials-bean | upload-keys-request. | N | Y | Y * | Device Credentials of Single Device. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | N | Link to this deviceCredentialsBean node in the current node context. |
space-user-name | String | N | Y | Y * | N | N | Space User Name. |
user-name | String | N | Y | Y * | N | N | User Name. |
host-name | String | N | Y | Y * | N | N | Host Name. |
password | String | N | Y | Y * | N | N | Password. |
ip-address | String | N | Y | Y * | N | N | IP Address. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
value | String | N | Y | Y * | Value. |
Field Name | Type | Read Only | GET | PUT / POST | Description | ||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this user node in the current node context. Hyperlink Template: /api/space/user-management/users/{*ID}. |
||||||||
@href | String(URI) | N | Y | Y * | Link to an external user. Hyperlink Template: /api/space/user-management/users/{*ID}. |
||||||||
*id | Integer | Y | Y | N | |||||||||
name | String | Y | Y | N | User Id. |
||||||||
first-name | String | Y | Y | N | First Name. |
||||||||
middle-name | String | Y | Y | N | Middle Name. |
||||||||
last-name | String | Y | Y | N | Last Name. |
||||||||
password | String | Y | Y | N | Password. |
||||||||
password-status | enum(password-status) | Y | Y | N | Password Status. Possible Values:
Default: ACTIVE. |
||||||||
password-expiry-date | Date | Y | Y | N | Password Expire Date. |
||||||||
status | String | Y | Y | N | Status. |
||||||||
primary-email | String | Y | Y | N | Primary Email. |
||||||||
primary-phone | String | Y | Y | N | Primary Phone. |
||||||||
domain-name | String | Y | Y | N | Domain Name. |
||||||||
api-access-profile | String | Y | Y | N | API Access Profile. |
||||||||
roles | user. | Y | Y | N | |||||||||
role-type | enum(role-type) | Y | Y | N | Role Type. Possible Values:
Default: ALL_ACCESS. |
||||||||
auth-mode | String | Y | Y | N | Auth Mode. Default: "Local". |
||||||||
active-user-sessions | user. | Y | Y | N | |||||||||
change-password | String | Y | Y | N | Change User Password. Hyperlink Template: /api/space/user-management/users/{*ID}/change-password. |
||||||||
enable-user | String | Y | Y | N | Enable the user. Hyperlink Template: /api/space/user-management/users/{*ID}/enable-user. |
||||||||
disable-user | String | Y | Y | N | Disable the user. Hyperlink Template: /api/space/user-management/users/{*ID}/disable-user. |
||||||||
capabilities | String | Y | Y | N | Capabilities for the user. Hyperlink Template: /api/space/user-management/users/{*ID}/capabilities. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this roles node in the current node context. Hyperlink Template: /api/space/user-management/users/{*ID}/roles. |
@total | Integer | Y | Y | N | Total number of gen_user-roles in the API result set. |
role | user. | N | Y | Y * |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | N | Link to this role node in the current node context. Hyperlink Template: /api/space/user-management/users/{*ID}/roles/{*ID}. |
@href | String(URI) | N | Y | Y * | N | N | Link to an external role. Hyperlink Template: /api/space/user-management/roles/{*ID}. |
role-id | Integer | Y | Y | N | N | N | Role ID. |
name | String | Y | Y | N | N | N | Role Name. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this activeUserSessions node in the current node context. Hyperlink Template: /api/space/user-management/users/{*ID}/active-user-sessions. |
@total | Integer | Y | Y | N | Total number of gen_user-active-user-sessions in the API result set. |
active-user-session | user. | N | Y | Y * |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | N | Link to this activeUser node in the current node context. Hyperlink Template: /api/space/user-management/users/{*ID}/active-user-sessions/{*ID}. |
@href | String(URI) | N | Y | Y * | N | N | Link to an external activeUser. Hyperlink Template: /api/space/user-management/active-user-sessions/{*ID}. |
id | Integer | Y | Y | N | N | N | ActiveUser ID. |
name | String | Y | Y | N | N | N | ActiveUser Name. |
Field Name | Type | Read Only | GET | PUT / POST | Description | ||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
@read-only | Boolean | N | Y | Y | Is this user read-only? | ||||||||
@uri | String(URI) | N | Y | Y | Link to this user node in the current node context. |
||||||||
id | Integer | N | Y | Y |
A unique identifier for the user. |
||||||||
title | String | N | Y | Y |
The user's title. |
||||||||
name | String | N | Y | Y * | The user's name | ||||||||
firstName | String | N | Y | Y * | The user's first name | ||||||||
middleName | String | N | Y | Y | The user's middle name | ||||||||
lastName | String | N | Y | Y * | The user's last name | ||||||||
viewAllObjects | Boolean | N | Y | Y | User can view all jobs or user's own jobs in job manager | ||||||||
password | String | N | Y | Y |
The user's password. |
||||||||
primaryPhone | String | N | Y | Y |
The user's primary phone. |
||||||||
primaryEmail | String | N | Y | Y |
The user's primary email. |
||||||||
imageId | int | N | Y | Y |
The user's image id. |
||||||||
image | String | N | Y | Y | User's image | ||||||||
imageName | String | N | Y | Y | Name of the User's image | ||||||||
temporaryPassword | String | N | Y | Y | The user's temporary password | ||||||||
is-locked | Boolean | Y | Y | N |
User locked out status. |
||||||||
password-status | enum(password-status) | Y | Y | N |
Password status. Possible Values:
|
||||||||
password-expiry-time | Date | N | Y | Y |
Password expiry time. |
||||||||
password-expiry-hours | long | N | Y | Y |
Expire hour for the temporary password. |
||||||||
authMode | String | N | Y | Y |
Authorization mode of the user. |
||||||||
status | String | N | Y | Y | Status. |
||||||||
roleType | enum(roleType) | N | Y | Y | Possible Values:
|
||||||||
use-global-settings | Boolean | N | Y | Y | |||||||||
maximum-concurrent-ui-sessions | Integer | N | Y | Y | |||||||||
auto-logout-time | Integer | N | Y | Y | |||||||||
use-global-logout-time | Boolean | N | Y | Y | |||||||||
roles | user. | N | Y | Y * |
The roles associated with the user. |
||||||||
x509-authentication-parameters | user. | N | Y | Y | X509 Certificate Authentication parameters associated with the user. |
||||||||
active-user-sessions | user. | N | Y | Y | The user sessions that are currently active for this user. |
||||||||
domains | user. | N | Y | Y | |||||||||
api-access-profile | user. | N | Y | Y | REST API access restriction rule for user. |
||||||||
certificate-id | String | N | Y | Y |
The user's certificate id. |
||||||||
certificate-name | String | N | Y | Y |
The user's certificate name. |
||||||||
certificate-file-name | String | N | Y | Y |
The user's certificate file name. |
||||||||
x509Certificate | String | N | Y | Y |
The user's certificate data in the string format. |
||||||||
method | String | N | Y | Y |
The supported operations provided by Junos Space for a user . |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | N | Y | Y | Link to this roles node in the current node context. |
role | user. | N | Y | Y * |
The collection of objects of type 'userrole'. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@href | String(URI) | N | Y | Y * | N | N | Link to an external userRole. |
@uri | String(URI) | N | Y | Y | N | N | Link to this userRole node in the current node context. |
id | Integer | N | Y | Y | N | N |
A unique identifier for the user role. |
name | String | N | Y | Y | N | N |
The name of the role. |
title | String | N | Y | Y | N | N |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | N | Y | Y | Link to this x509CertAuthParamMos node in the current node context. |
x509-authentication-parameter | user. | N | Y | Y * | Get User Information by ID. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@uri | String(URI) | N | Y | Y | N | N | Link to this x509AuthParamValue node in the current node context. |
parameter-value | String | N | Y | Y * | N | N | Parameter Value. |
x509-certificate-parameter | user. | N | Y | Y * | N | N | x509-certificate-parameter consists of the field to hold parameter name. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | N | Y | Y | Link to this x509CertificateParameter node in the current node context. |
x509-parameter-name | String | N | Y | Y * | Name of the x509 certification parameter. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | N | Y | Y | Link to this activeUserSessions node in the current node context. |
active-user-session | user. | N | Y | Y | The collection of objects of type 'active-user-session'. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@href | String(URI) | N | Y | Y * | N | N | Link to an external activeUserSession. |
@uri | String(URI) | N | Y | Y | N | N | Link to this activeUserSession node in the current node context. |
id | Integer | N | Y | Y | N | N | A unique identifier for the user session. |
ip-address | String | N | Y | Y | N | N | The IP address of the user session. |
session-start-time | String | N | Y | Y | N | N | The session start time of the user session. |
fabric-node-name | String | N | Y | Y | N | N | user logged-in node name. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this domains node in the current node context. |
@total | Integer | Y | Y | N | Total number of gen_users-users-domains in the API result set. |
domain | user. | N | Y | Y * | Domain for user. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | N | Link to this domain node in the current node context. Hyperlink Template: /api/space/user-management/users/{*ID}. |
@href | String(URI) | N | Y | Y * | N | N | Link to an external domain. Hyperlink Template: /api/space/domain-management/domains/{*ID}. |
id | Integer | Y | Y | N | N | N | Domain ID. |
name | String | Y | Y | N | N | N | Domain Name. Default: "Global". |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@href | String(URI) | Y | Y | N | Link to an external apiAccessProfile. Hyperlink Template: /api/space/user-management/api-access-profiles/{*ID}. |
id | Integer | Y | Y | N | Id of the api access profile. |
name | String | N | Y | Y * | Name of the api access profile. |
description | String | N | Y | Y * | Description for the api access profile. |
exec-rpc-rules | user. | N | Y | Y |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this rpcRules node in the current node context. |
exec-rpc-rule | user. | N | Y | Y * |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | N | Link to this aPIRPCRule node in the current node context. |
rule | String | N | Y | Y * | N | N | RPC restriction rule. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | N | Y | Y | Link to this user node in the current node context. |
auto-logout | Integer | N | Y | Y * |
Time in minutes for the user to be logged out automatically. |
concurrent-gui-sessions-per-user | Integer | N | Y | Y * | |
inactive-user-time-period | Integer | N | Y | Y * | |
ui-auto-refresh-interval | Long | N | Y | Y * |
Time in seconds for the UI to be refreshed automatically. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@key | Integer | N | Y | Y * | The unique identifier for the user session. |
@href | String(URI) | N | Y | Y * | Link to an external user-active-user-session. |
@uri | String(URI) | N | Y | Y * | Link to this user-active-user-session node in the current node context. |
user-name | String | N | Y | Y * | Logged in user session. |
ip-address | String | N | Y | Y | The IP address of the user session. |
session-start-time | String | N | Y | Y | The start time of the user's session. |
fabric-node-name | String | N | Y | Y | user logged-in node name. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | N | Y | Y | Link to this user-active-user-sessions node in the current node context. |
@size | Integer | N | Y | Y | The total number of user sessions associated with a user. |
active-user-session | user-active-user-sessions. | N | Y | Y * | The collection of objects of type 'userSession'. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@key | Integer | N | Y | Y | N | N | A unique identifier for the user session. |
@href | String(URI) | N | Y | Y | N | N | Link to an external userSession. |
@uri | String(URI) | N | Y | Y | N | N | Link to this userSession node in the current node context. |
id | Integer | N | Y | Y | N | N | The user session id. |
user-name | String | N | Y | Y | N | N | The logged in user name. |
ip-address | String | N | Y | Y | N | N | The IP address of the user session. |
session-start-time | String | N | Y | Y | N | N | The start time of the user's session. |
fabric-node-name | String | N | Y | Y | N | N | user logged-in node name. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this user-preference-state-response node in the current node context. |
*id | Integer | Y | Y | N | UserPreferenceState ID. |
state-name | String | N | Y | Y * | State Name. |
state-value | String | N | Y | Y * | State Value. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this user-profile node in the current node context. Hyperlink Template: /api/space/user-management/user-profiles/{*ID}. |
@href | String(URI) | Y | Y | N | Link to an external user-profile. Hyperlink Template: /api/space/user-management/user-profiles/{*ID}. |
*id | Integer | Y | Y | N | UserProfile ID. |
name | String | N | Y | Y * | UserProfile Name. |
title | String | N | Y | Y * | Title. |
auth-mode | String | N | Y | Y * | Auth Mode. |
x509-cert-auth-mode | String | N | Y | Y * | X509 Cert Auth Mode. Default: "NO". |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this user-profiles node in the current node context. |
@total | Integer | Y | Y | N | Total number of user-profiles in the API result set. |
user-profile | user-profiles. | N | Y | Y * |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | N | Link to this userProfile node in the current node context. Hyperlink Template: /api/space/user-management/user-profiles/{*ID}. |
@href | String(URI) | Y | Y | N | N | N | Link to an external user-profile. Hyperlink Template: /api/space/user-management/user-profiles/{*ID}. |
id | Integer | Y | Y | N | Y | Y | UserProfile ID. |
x509-cert-auth-mode | String | Y | Y | N | N | N | X509 Cert Auth Mode. Default: "NO". |
title | String | Y | Y | N | Y | Y | Title. |
domain-id | Integer | N | Y | Y | N | N | Domain ID. |
name | String | Y | Y | N | Y | Y | UserProfile Name. |
domain-name | String | Y | Y | N | N | N | Domain Name. |
auth-mode | String | Y | Y | N | Y | Y | Auth Mode. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@href | String(URI) | N | Y | Y * | Link to an external user-ref. |
id | Integer | N | Y | Y |
The unique identifier for the user. |
name | String | N | Y | Y |
The name of the user. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this user-ref node in the current node context. Hyperlink Template: /api/space/domain-management/domains/{*ID}/users/{*ID}. |
@href | String(URI) | N | Y | Y * | Link to an external user-ref. Hyperlink Template: /api/space/user-management/users/{*ID}. |
*id | Integer | Y | Y | N | |
name | String | N | Y | Y | User Id. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this user-refs node in the current node context. |
@total | Integer | Y | Y | N | Total number of users in the API result set. |
user | user-refs. | N | Y | Y * |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@href | String(URI) | N | Y | Y * | N | N | Link to an external user. Hyperlink Template: /api/space/user-management/users/{*ID}. |
@uri | String(URI) | Y | Y | N | N | N | Link to this user node in the current node context. Hyperlink Template: /api/space/domain-management/domains/{*ID}/users. |
primary-email | String | N | Y | Y | Y | Y | Primary email of the user. |
status | String | N | Y | Y | Y | Y | Current status of the user (enabled or disabled). |
domains | user-refs. | N | Y | Y | N | N | |
last-name | String | N | Y | Y | Y | Y | |
id | Integer | Y | Y | N | Y | Y | |
name | String | N | Y | Y | Y | Y | |
first-name | String | N | Y | Y | Y | Y |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this domains node in the current node context. Hyperlink Template: /api/space/domain-management/domains/{*ID}/users/domains. |
@total | Integer | Y | Y | N | Total number of gen_users-users-assigned-to-domains-domains in the API result set. |
@href | String(URI) | N | Y | Y | Link to an external domains. Hyperlink Template: /api/space/domain-management/domains/{*ID}/users/domains. |
domain | user-refs. | N | Y | Y * |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@href | String(URI) | N | Y | Y * | N | N | Link to an external domain. Hyperlink Template: /api/space/domain-management/domains/{*ID}. |
@uri | String(URI) | Y | Y | N | N | N | Link to this domain node in the current node context. Hyperlink Template: /api/space/domain-management/domains/{*ID}/users/domains/{*ID}. |
id | Integer | Y | Y | N | N | N | ID of domain. |
name | String | N | Y | Y | N | N |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this users node in the current node context. |
@total | Integer | Y | Y | N | Total number of users in the API result set. |
user | users. | N | Y | Y * | Get all users. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description | ||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | N | Link to this user node in the current node context. Hyperlink Template: /api/space/user-management/users/{*ID}. |
||||||||
@href | String(URI) | Y | Y | N | N | N | Link to an external user. Hyperlink Template: /api/space/user-management/users/{*ID}. |
||||||||
id | Integer | Y | Y | N | Y | Y | User ID. |
||||||||
name | String | N | Y | Y | Y | Y | User Name. |
||||||||
first-name | String | N | Y | Y * | Y | Y | First Name. |
||||||||
last-name | String | N | Y | Y * | Y | Y | Last Name. |
||||||||
primary-email | String | N | Y | Y | Y | Y | Primary Email. |
||||||||
domains | users. | N | Y | Y | N | N | All domains this user belongs to. |
||||||||
auth-mode | String | N | Y | Y | Y | Y | Auth Mode. Default: "Local". |
||||||||
status | String | N | Y | Y * | Y | Y | Status. |
||||||||
password-status | enum(password-status) | N | Y | Y | Y | N | Password Status. Possible Values:
|
||||||||
role-type | enum(role-type) | N | Y | Y | Y | Y | Role Type. Possible Values:
Default: ALL_ACCESS. |
||||||||
lock-out-status | String | N | Y | Y | Y | Y | Lock Out Status. |
||||||||
read-only | Boolean | N | Y | Y | Y | Y | This user can only read or monitor data. Default: false. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this domains node in the current node context. |
@total | Integer | Y | Y | N | Total number of gen_users-users-domains in the API result set. |
domain | users. | N | Y | Y * | Domain for user. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | N | Link to this domain node in the current node context. Hyperlink Template: /api/space/user-management/users/{*ID}. |
@href | String(URI) | N | Y | Y * | N | N | Link to an external domain. Hyperlink Template: /api/space/domain-management/domains/{*ID}. |
id | Integer | Y | Y | N | N | N | Domain ID. |
name | String | Y | Y | N | N | N | Domain Name. Default: "Global". |
Field Name | Type | Read Only | GET | PUT / POST | PATCH | Description |
---|---|---|---|---|---|---|
@uri | String(URI) | N | Y | Y * | N | Link to this users node in the current node context. |
@size | Integer | N | Y | Y * | N | The size of records returned by the API |
@total | Integer | N | Y | Y * | N | Total number of users in the API result set. |
user | users. | N | Y | Y * | Y |
The collection of objects of type 'user'. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description | ||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
key | Integer | N | Y | Y | N | N |
A unique identifier for the user. |
||||||
name | String | N | Y | Y | Y | Y |
The user's name. |
||||||
primaryEmail | String | N | Y | Y | Y | Y | The user's primary email | ||||||
primaryPhone | String | N | Y | Y | N | N | The user's primary phone | ||||||
firstName | String | N | Y | Y | Y | Y | The user's first name | ||||||
lastName | String | N | Y | Y | Y | Y | The user's last name | ||||||
uri | String | N | Y | Y | N | N |
A link to identify the 'user' resource. |
||||||
href | String | N | Y | Y | N | N |
The location of the 'user' resource. |
||||||
roleType | enum(roleType) | N | Y | Y | N | N | Possible Values:
|
||||||
read-only | Boolean | N | Y | Y | Y | Y | Is this a read-only user? |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this users node in the current node context. |
@total | Integer | Y | Y | N | Total number of users in the API result set. |
user | users. | N | Y | Y * |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | N | Link to this user node in the current node context. Hyperlink Template: /api/space/domain-management/domains/{*ID}/users/{*ID}. |
@href | String(URI) | N | Y | Y * | N | N | Link to an external user. Hyperlink Template: /api/space/user-management/users/{*ID}. |
id | Integer | Y | Y | N | Y | Y | |
name | String | Y | Y | N | Y | Y | User Name. |
first-name | String | Y | Y | N | Y | Y | First Name. |
middle-name | String | Y | Y | N | N | N | Middle Name. |
last-name | String | Y | Y | N | Y | N | Last Name. |
primary-email | String | Y | Y | N | Y | Y | Primary Email. |
domains | users. | Y | Y | N | N | N |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this domains node in the current node context. |
@total | Integer | Y | Y | N | Total number of gen_users-users-assigned-to-domains-domains in the API result set. |
domain | users. | N | Y | Y * |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@href | String(URI) | N | Y | Y * | N | N | Link to an external domain. Hyperlink Template: /api/space/domain-management/domains/{*ID}. |
id | Integer | Y | Y | N | N | N | Domain ID. |
name | String | Y | Y | N | N | N | Domain Name. |
description | String | Y | Y | N | N | N | Description. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this users-refs node in the current node context. |
@total | Integer | Y | Y | N | Total number of users in the API result set. |
user | users-refs. | N | Y | Y * |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@href | String(URI) | N | Y | Y * | N | N | Link to an external user. Hyperlink Template: /api/space/user-management/users/{*ID}. |
@uri | String(URI) | Y | Y | N | N | N | Link to this user node in the current node context. Hyperlink Template: /api/space/domain-management/domains/{*ID}/users. |
primary-email | String | N | Y | Y | Y | Y | Primary email of the user. |
auth-mode | String | Y | Y | N | N | N | Auth Mode. Default: "Local". |
status | String | N | Y | Y | Y | Y | Current status of the user (enabled or disabled). |
domains | users-refs. | N | Y | Y | N | N | Last Name. |
last-name | String | N | Y | Y | Y | Y | |
id | Integer | Y | Y | N | Y | Y | |
name | String | N | Y | Y | Y | Y | User Name. |
first-name | String | N | Y | Y | Y | Y | First Name. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this domains node in the current node context. Hyperlink Template: /api/space/domain-management/domains/{*ID}/users/domains. |
@total | Integer | Y | Y | N | Total number of gen_users-users-assigned-to-domains-domains in the API result set. |
@href | String(URI) | N | Y | Y | Link to an external domains. Hyperlink Template: /api/space/domain-management/domains/{*ID}/users/domains. |
domain | users-refs. | N | Y | Y * |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@href | String(URI) | N | Y | Y * | N | N | Link to an external domain. Hyperlink Template: /api/space/domain-management/domains/{*ID}. |
@uri | String(URI) | Y | Y | N | N | N | Link to this domain node in the current node context. Hyperlink Template: /api/space/domain-management/domains/{*ID}/users/domains/{*ID}. |
id | Integer | Y | Y | N | N | N | ID of domain. |
name | String | N | Y | Y | N | N |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this validate-cli-configlet node in the current node context. |
device | validate-cli-configlet. | N | Y | Y * | Unique reference to the Device for which the configlet is applicable. |
context | String | N | Y | Y | Context XPATH. |
cli-configlet-params | validate-cli-configlet. | N | Y | Y | Collection of Configlet Parameters. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@href | String(URI) | N | Y | Y * | Link to an external device. Hyperlink Template: /api/space/device-management/devices/{*ID}. |
id | Integer | Y | Y | N | Unique ID of the Device. |
name | String | Y | Y | N | Device Name. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this cliConfigletParams node in the current node context. |
cli-configlet-param | validate-cli-configlet. | N | Y | Y * | Configlet Parameter. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | N | Link to this configletParamForNBI node in the current node context. |
parameter | validate-cli-configlet. | N | Y | Y * | N | N | Unique reference to the Configlet Parameter. |
parameter-value | String | N | Y | Y * | N | N | Value for the Configlet Parameter. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@href | String(URI) | N | Y | Y * | Link to an external paramForNBI. Hyperlink Template: /api/space/configuration-management/cli-configlets/{*ID}/cli-configlet-params/{*ID}. |
param-id | Integer | Y | Y | N | Unique ID of the Configlet Parameter. |
name | String | Y | Y | N | Parameter Name. |
configlet-id | Integer | Y | Y | N | Configlet ID. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this validate-cli-configlet node in the current node context. |
configlet | validate-cli-configlet. | N | Y | Y * | Unique reference to the Configlet that to be validated on the Device. |
cli-configlet-params | validate-cli-configlet. | N | Y | Y | Collection of Configlet Parameters. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@href | String(URI) | N | Y | Y * | Link to an external cliConfigurationTemplate. Hyperlink Template: /api/space/configuration-management/cli-configlets/{*ID}. |
id | Integer | Y | Y | N | Unique ID of the Configlet. |
name | String | Y | Y | N | Configlet Name The name of the configlet and it cannot exceed 255 characters. You cannot have two configlets with the same name in one domain and if this configlet have to be included by other configlets via #mixin directive, then configlet name should not have SPACE and DOT(. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this cliConfigletParams node in the current node context. |
cli-configlet-param | validate-cli-configlet. | N | Y | Y * | Configlet Parameter. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | N | Link to this configletParamForNBI node in the current node context. |
parameter | validate-cli-configlet. | N | Y | Y | N | N | Unique reference to the Configlet Parameter. |
parameter-value | String | N | Y | Y * | N | N | Value for the Configlet Parameter. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@href | String(URI) | N | Y | Y * | Link to an external paramForNBI. Hyperlink Template: /api/space/configuration-management/cli-configlets/{*ID}/cli-configlet-params/{*ID}. |
param-id | Integer | Y | Y | N | Unique ID of the Configlet Parameter. |
name | String | Y | Y | N | Parameter Name. |
configlet-id | Integer | Y | Y | N | Configlet ID. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this validate-cli-configlet-job-results node in the current node context. |
@total | Integer | Y | Y | N | Total number of validate-cli-configlet-job-results in the API result set. |
validate-cli-configlet-job-result | validate-cli-configlet-job-results. | N | Y | Y * | Validate cli configlet job result detail. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | N | N | Link to this validateCLIConfigletJobResult node in the current node context. |
||||||||||
id | Integer | Y | Y | N | N | N | Unique ID of the validate cli configlet job detail. |
||||||||||
job-id | Integer | Y | Y | N | N | N | Unique ID of the job. |
||||||||||
job-status | enum(job-status) | N | Y | Y | Y | Y | Status of validate cli configlet job. Possible Values:
|
||||||||||
job-remarks | String | Y | Y | N | Y | Y | Validate cli configlet job remarks. |
||||||||||
job-percentage-completed | Double | Y | Y | N | N | N | Job Percentage Completed. |
||||||||||
cli-configlet-id | Integer | Y | Y | N | Y | Y | Unique ID of the configlet. |
||||||||||
cli-configlet-name | String | Y | Y | N | Y | Y | Name of the configlet. |
||||||||||
category | String | Y | Y | N | N | N | Category of the configlet. |
||||||||||
context | String | Y | Y | N | N | N | Context of the configlet. |
||||||||||
validated-configuration | String | Y | Y | N | N | N | Configuration that is validated on the Device. |
||||||||||
device-id | Integer | Y | Y | N | N | N | Unique ID of the device. |
||||||||||
device-name | String | Y | Y | N | Y | Y | Name of the device on which the configlet is validated. |
||||||||||
device | String | Y | Y | N | N | N | Unique link for the Device Hyperlink Template: /api/space/device-management/devices/{*ID}. |
||||||||||
job | String | Y | Y | N | N | N | Unique link for the Job Hyperlink Template: /api/space/job-management/jobs/{*ID}. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this validate-password-request node in the current node context. |
user-name | String | N | Y | Y * | Name of the user. |
password | String | N | Y | Y * | Password string to be validated for the user. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | Y | Y | N | Link to this validate-password-response node in the current node context. |
@total | Integer | Y | Y | N | Total number of validate-password-response in the API result set. |
error-message | String[] | N | Y | Y * | Error message result after password validation. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | N | Y | Y | Link to this versions-diff node in the current node context. |
config-file-versions | versions-diff. | N | Y | Y | Versions being compared. |
diffs | versions-diff. | N | Y | Y | List of differences. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
config-file-version | versions-diff. | N | Y | Y | A single version. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@href | String(URI) | N | Y | Y | N | N | Link to an external configFileVersionMO. |
@uri | String(URI) | N | Y | Y | N | N | Link to this configFileVersionMO node in the current node context. |
version-creation-time | String | N | Y | Y | N | N | |
id | int | N | Y | Y | N | N | Version Href ID. |
versionId | int | N | Y | Y | N | N | Version ID. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
diff | versions-diff. | N | Y | Y | A single difference. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
origLine | String | N | Y | Y | N | N | Original value found at line number. |
reason | String | N | Y | Y | N | N | Reason for difference. |
lineNumber | int | N | Y | Y | N | N | Line number where difference was found. |
newLine | String | N | Y | Y | N | N | New value found at line number. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | N | Y | Y | Link to this view-associated-devices node in the current node context. |
@size | Integer | N | Y | Y | The total number of results available |
script-device-association | view-associated-devices. | N | Y | Y * |
The collection of associations. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description | ||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
device | view-associated-devices. | N | Y | Y * | N | N | The device type on which the operation is to be performed | ||||||
script-name | String | N | Y | Y * | Y | Y | The name of the script | ||||||
category | String | N | Y | Y | Y | Y |
The script category. |
||||||
deployed-version | String | N | Y | Y * | N | N | The script deployed version | ||||||
script-status | enum(script-status) | N | Y | Y * | N | N |
The script status, which is enabled or disabled. Possible Values:
|
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@href | String(URI) | N | Y | Y | Link to an external device. |
@uri | String(URI) | N | Y | Y | Link to this device node in the current node context. |
device-id | Long | N | Y | Y * | A unique identifier for the device |
device-name | String | N | Y | Y * | The name of the device |
ip-address | String | N | Y | Y * | The IP address of the device. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@size | Integer | N | Y | Y | |
@uri | String(URI) | N | Y | Y | Link to this view-customized-attributes node in the current node context. |
customized-attribute | view-customized-attributes. | N | Y | Y * |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
id | int | N | Y | Y | N | N | |
name | String | N | Y | Y * | N | N | |
value | String | N | Y | Y * | N | N |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@size | Integer | N | Y | Y | The total size of the managed labels. |
@uri | String(URI) | N | Y | Y | Link to this view-manage-labels node in the current node context. |
customized-attribute | view-manage-labels. | N | Y | Y | The metadata for the managed labels. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@uri | String(URI) | N | Y | Y | N | N | Link to this jSELabelMetaData node in the current node context. |
@href | String(URI) | N | Y | Y | N | N | Link to an external jSELabelMetaData. |
id | int | N | Y | Y | N | N | The ID of the managed label. |
name | String | N | Y | Y * | N | N | The name of the managed label. |
value | String | N | Y | Y * | N | N | The data of the managed label. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | N | Y | Y | Link to this virtual-chassis node in the current node context. |
chassis-exists | String | N | Y | Y | This field indicates whether a virtual chassis exists for the managed element. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | N | Y | Y | Link to this vlans node in the current node context. |
@size | Integer | N | Y | Y | The size of the collection |
vlan | vlans. | N | Y | Y | The collection of VLANs |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
description | String | N | Y | Y | N | N | A description of the VLAN |
vlanId | Integer | N | Y | Y * | N | N | The ID of the VLAN |
vlanRange | String | N | Y | Y | N | N | The VLAN ID range |
l3Interface | String | N | Y | Y | N | N | The routing interface, which includes a bridge domain or a VPLS routing instance |
vlanType | String | N | Y | Y | N | N | Type of VLAN. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
xpath | String[] | N | Y | Y * |
XPath to be passed to get the configuration. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | N | Y | Y | Link to this change-request node in the current node context. |
id | Integer | N | Y | Y * |
A unique identifier for the change-request. |
name | String | N | Y | Y |
Name of the change request. |
description | String | N | Y | Y |
Description for the change request. |
xmlData | String | N | Y | Y |
The configuration data needed for the change request. |
device | change-request. | N | Y | Y * |
The representation of the device. |
syncAfterPush | Boolean | N | Y | Y |
Whether to re-synchronize the device after the configuration update or not. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@href | String(URI) | N | Y | Y | Link to an external device. |
@uri | String(URI) | N | Y | Y | Link to this device node in the current node context. |
id | Long | N | Y | Y |
Unique identifier for the device. |
deviceFamily | String | N | Y | Y |
Family of the device. |
OSVersion | String | N | Y | Y |
Version of operating system on the device. |
platform | String | N | Y | Y |
Platform of the device. |
serialNumber | String | N | Y | Y | Serial Number of the device |
connectionStatus | String | N | Y | Y | Connection status of the device |
ipAddr | String | N | Y | Y |
IP Address of the device. |
managedStatus | String | N | Y | Y |
Managed status of the device. |
name | String | N | Y | Y |
Name of the device. |
hostName | String | N | Y | Y |
Host Name of the device. |
otp | String | N | Y | Y |
One time password of the device. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
ruleName | String | N | Y | Y * | Unique rule name |
discoveryMethods | DiscoveryTarget[] | N | Y | Y | Discovery target schemes |
usePing | Boolean | N | Y | Y | A flag for using ping |
useSnmp | Boolean | N | Y | Y | A flag for using SNMP |
snmpSettings | SnmpSetting[] | N | Y | Y | SNMP setting schemes |
manageDiscoveredSystemsFlag | Boolean | N | Y | Y | Boolean for managing the discovery system |
credentials | Credential[] | N | Y | Y |
List of credentials for testing the connectivity of the discovered system. |
tagNewlyManagedDiscoveredSystemsFlag | Boolean | N | Y | Y | Boolean to tag newly discovered systems |
tagForNewlyManagedDiscoveredSystems | String | N | Y | Y | Tag name to tag newly discovered systems |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@uri | String(URI) | N | Y | Y | N | N | Link to this equipment-holder node in the current node context. |
id | Integer | N | Y | Y * | N | N | The ID of the equipment holder |
name | String | N | Y | Y | N | N | The name of the equipment holder |
path | String | N | Y | Y | N | N | The location of the element in the managed element |
alias | String | N | Y | Y | N | N | |
containedEquipment | equipment-holder[] | N | Y | Y | N | N | The equipment and equipment holders directly contained by this equipment holder |
holderType | String | N | Y | Y | N | N | The current type of the equipment holder with respect to the contained equipment |
holderState | String | N | Y | Y | N | N | The current condition of the equipment holder with respect to the contained equipment |
expectedOrInstalledEquipment | routing-engine | N | Y | Y | N | N | The equipment that is installed or is expected to be installed in the physical container represented by the equipment holder |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
scriptMgmt | exec-deploy. | N | Y | Y * | The set of inputs for the operation |
forceRemove | boolean | N | Y | Y |
A flag that indicates whether to forcibly remove the association between
a device and a script while removing script from the device. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
scriptId | Integer | N | Y | Y * | N | N |
The ID of the script. |
scriptVersionSelected | Float | N | Y | Y | N | N | The version of the script. |
deviceId | Integer | N | Y | Y * | N | N |
The ID of the device on which to perform the operation. |
scriptParam | exec-deploy. | N | Y | Y | N | N |
The list of parameters needed by the script. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
paramName | String | N | Y | Y * | N | N |
The parameter name. |
paramValue | String | N | Y | Y * | N | N |
The parameter value. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
configuration | String | N | Y | Y * |
The configuration string. |
id | Integer | N | Y | Y | Unique identifier for expanded configuration |
method | String | N | Y | Y |
This represent a link to a POST method that is used to match the content of the configuration. |
Field Name | Type | Read Only | GET | PUT / POST | Description | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
@uri | String(URI) | N | Y | Y * | Link to this job node in the current node context. |
||||||||||
id | Integer | N | Y | Y * | The ID of the job | ||||||||||
name | String | N | Y | Y * | The name of the job | ||||||||||
percent | Double | N | Y | Y * | The percent of job completion | ||||||||||
status | enum(status) | N | Y | Y * |
The job status
Possible Values:
|
||||||||||
jobType | String | N | Y | Y |
The job type. |
||||||||||
summary | String | N | Y | Y | A summary of the job | ||||||||||
scheduledStartTime | String | N | Y | Y | The scheduled start time | ||||||||||
user | String | N | Y | Y | The user | ||||||||||
recurrence | String | N | Y | Y |
A flag that indicates whether the job is recurring. |
||||||||||
progress-update | job. | N | Y | Y | A type containing the location of the job's progress update |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
href | String | N | Y | Y | The link to job's progress update |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | N | Y | Y * | Link to this jobs node in the current node context. |
@size | Integer | N | Y | Y | The total number of jobs available in the system |
job | jobs. | N | Y | Y |
A type containing pull-through data for a job. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
href | String | N | Y | Y | N | N |
The location of the 'job' resource. |
||||||||||||||
uri | String | N | Y | Y | N | N | A link to identify the the 'job' resource | ||||||||||||||
key | Integer | N | Y | Y | Y | Y |
A unique identifier for the job. |
||||||||||||||
name | String | N | Y | Y | N | N |
The name of the job. |
||||||||||||||
recurring | Boolean | N | Y | Y | N | N |
A flag that indicates whether the job is recurring or not. |
||||||||||||||
status | enum(status) | N | Y | Y | N | N |
The job status
Possible Values:
|
||||||||||||||
state | enum(state) | N | Y | Y | N | N |
The job state
Possible Values:
|
||||||||||||||
user | String | N | Y | Y | Y | Y |
The user who created the job. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
deviceFamily | String | N | Y | Y * | Device family |
deviceConfig | String | N | Y | Y * | Device configuration |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
statusCode | String | N | Y | Y | Status code |
mergedConfiglet | String | N | Y | Y | Merged configlet |
errorMessage | String | N | Y | Y | Error message |
errorDetails | String | N | Y | Y | Error details |
rpc_reply | String | N | Y | Y | RPC reply |
rpc_request | String | N | Y | Y | RPC request |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
statusCode | String | N | Y | Y | Status code |
mergedConfiglet | String | N | Y | Y | Merged configlet |
errorMessage | String | N | Y | Y | Error message |
errorDetails | String | N | Y | Y | Error details |
rpc_reply | String | N | Y | Y | RPC reply |
rpc_request | String | N | Y | Y | RPC request |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
oldPassword | String | N | Y | Y * | The user's old password |
newPassword | String | N | Y | Y * |
The user's new password. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
configuration | String | N | Y | Y * |
The configuration string. |
id | Integer | N | Y | Y |
The configuration string. |
method | String | N | Y | Y |
This represent a link to a POST method that is used to match the content of the configuration. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | N | Y | Y * | Link to this role node in the current node context. |
id | Integer | N | Y | Y * |
The unique identifier for the role. |
name | String | N | Y | Y * |
The name of the role. |
title | String | N | Y | Y |
The title of the role. |
description | String | N | Y | Y |
The description of the role. |
capabilities | role. | N | Y | Y |
The capabilities associated with the role. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
capability | role. | N | Y | Y |
The collection of objects of type 'rolecapability'. |
uri | String | N | Y | Y |
A link to identify the capabilities associated with a role. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
id | Integer | N | Y | Y | N | N |
A unique identifier for the role capability. |
name | String | N | Y | Y | N | N |
The name of the capability. |
href | String | N | Y | Y | N | N |
The location of a capability. |
uri | String | N | Y | Y | N | N |
A link to identify the capabilities associated with the role. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | N | Y | Y * | Link to this roles node in the current node context. |
@size | Integer | N | Y | Y * |
The total number of roles available in the system. |
role | roles. | N | Y | Y * |
The collection of objects of type 'role'. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
key | Integer | N | Y | Y | N | N |
A unique identifier for the role. |
name | String | N | Y | Y | N | N |
The name of the role. |
uri | String | N | Y | Y | N | N |
A link to identify the 'role' resource. |
href | String | N | Y | Y | N | N |
The location of the 'role' resource. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@size | Integer | N | Y | Y | Size of the resource collection |
@uri | String(URI) | N | Y | Y | Link to this scripts node in the current node context. |
script | scripts. | N | Y | Y * |
The scripts that are available on Junos Space. |
method | String | N | Y | Y |
The supported operations for scripts provided by Junos Space. |
method | String | N | Y | Y |
The Supported operations for scripts provided by Junos Space. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description |
---|---|---|---|---|---|---|---|
@uri | String(URI) | N | Y | Y | N | N | Link to this scriptMO node in the current node context. |
@href | String(URI) | N | Y | Y | N | N | Link to an external scriptMO. |
@key | String | N | Y | Y | N | N | The ID of the script |
scriptName | String | N | Y | Y * | Y | Y |
The name of the script. |
category | String | N | Y | Y | Y | Y |
Category of the script. |
domain-name | String | N | Y | Y | N | N | |
domain-id | Integer | N | Y | Y | N | N |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | N | Y | Y | Link to this scripts-results node in the current node context. |
@size | Integer | N | Y | Y |
Total number of results available. |
scriptResult | scripts-results. | N | Y | Y * |
The collection of results. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description | ||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
scriptID | Integer | N | Y | Y | N | N | The script ID. |
||||||||||||||||||||||
scriptName | String | N | Y | Y * | N | N |
The name of the script. |
||||||||||||||||||||||
deviceId | Integer | N | Y | Y * | N | N | The identifier for the device on which the script was executed | ||||||||||||||||||||||
actionType | enum(actionType) | N | Y | Y * | N | N |
The type of action performed on the script. Possible Values:
|
||||||||||||||||||||||
scriptMgmtJobStatus | enum(scriptMgmtJobStatus) | N | Y | Y * | N | N |
The status of the action performed. Possible Values:
|
||||||||||||||||||||||
jobRemarks | String | N | Y | Y | N | N |
Remarks for the performed action. |
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@uri | String(URI) | N | Y | Y | Link to this view-associated-devices node in the current node context. |
@size | Integer | N | Y | Y |
Total number of results available. |
script-device-association | view-associated-devices. | N | Y | Y * |
The collection of associations. |
Field Name | Type | Read Only | GET | PUT / POST | Sort | Filter | Description | ||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
device | view-associated-devices. | N | Y | Y * | N | N | The Device HREF on which the script is run. |
||||||
script-name | String | N | Y | Y * | Y | Y | The name of the script | ||||||
category | String | N | Y | Y | Y | Y |
Category of the script. |
||||||
deployed-version | String | N | Y | Y * | N | N |
The script deployed version. |
||||||
script-status | enum(script-status) | N | Y | Y * | N | N |
The script status, which is enabled or disabled
Possible Values:
|
Field Name | Type | Read Only | GET | PUT / POST | Description |
---|---|---|---|---|---|
@href | String(URI) | N | Y | Y | Link to an external device. |
@uri | String(URI) | N | Y | Y | Link to this device node in the current node context. |
device-id | Long | N | Y | Y * |
A unique identifier for the device. |
device-name | String | N | Y | Y * |
The name of the device. |
ip-address | String | N | Y | Y * | The IP address of the device. |