REST API Resource Model

Media Type Diagram



Media Types

Media Type Index


Resource Model Tables

acknowledge-device-fingerprint-request (vnd.net.juniper.space.device-management.acknowledge-device-fingerprint-request;version=2)

acknowledge-device-fingerprint-request node details

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this acknowledge-device-fingerprint-request node in the current node context. This link can be used to retrieve or operate on the currently referenced acknowledge-device-fingerprint-request in the tree path.
acknowledge-devicesacknowledge-device-fingerprint-request.acknowledgeDeviceListsNY Y List of acknowledge-devices.

acknowledge-device-fingerprint-request.acknowledgeDeviceLists

List of acknowledge-devices.

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this acknowledgeDeviceLists node in the current node context. This link can be used to retrieve or operate on the currently referenced acknowledgeDeviceLists in the tree path.
acknowledge-deviceacknowledge-device-fingerprint-request.acknowledgeDeviceLists.acknowledgeDevice[]NY Y * "acknowledge-device" node provides details of devices and their corresponding fingerprints. If the optional fingerprint is not specified, then a default fingerprint value will be used for the acknowledgement.

acknowledge-device-fingerprint-request.acknowledgeDeviceLists.acknowledgeDevice

"acknowledge-device" node provides details of devices and their corresponding fingerprints. If the optional fingerprint is not specified, then a default fingerprint value will be used for the acknowledgement.

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)YY N NNLink to this acknowledgeDevice node in the current node context. This link can be used to retrieve or operate on the currently referenced acknowledgeDevice in the tree path.
deviceacknowledge-device-fingerprint-request.acknowledgeDeviceLists.acknowledgeDevice.deviceNY Y * NN"device" node is used to specify the device which is used in the acknowledgement operation.
fingerprintStringNY Y NNSSH Public key Fingerprint. A Fingerprint is a short vrsion of the device's public key and it is easier to verify the fingerprint than the full public key.

acknowledge-device-fingerprint-request.acknowledgeDeviceLists.acknowledgeDevice.device

"device" node is used to specify the device which is used in the acknowledgement operation.

Field NameTypeRead OnlyGETPUT / POSTDescription
@hrefString(URI)NY Y * Link to an external device. Here, href points to the device in the primary device collection.

Hyperlink Template: /api/space/device-management/devices/{*ID}.
idIntegerYY N Device ID.
nameStringYY N Device Name.

acknowledge-fingerprint-job-results (vnd.net.juniper.space.device-management.acknowledge-fingerprint-job-results;version=3)

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this acknowledge-fingerprint-job-results node in the current node context. This link can be used to retrieve or operate on the currently referenced acknowledge-fingerprint-job-results in the tree path.
@totalIntegerYY N Total number of acknowledge-fingerprint-job-results in the API result set. If paging parameters are used in the query to limit the result set size, then total represents the total number of acknowledge-fingerprint-job-results in all the pages of the result set.
acknowledge-device-fingerprint-job-resultacknowledge-fingerprint-job-results.acknowledgeDeviceFingerprintJobResult[]NY Y *  

acknowledge-fingerprint-job-results.acknowledgeDeviceFingerprintJobResult

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)YY N NNLink to this acknowledgeDeviceFingerprintJobResult node in the current node context. This link can be used to retrieve or operate on the currently referenced acknowledgeDeviceFingerprintJobResult in the tree path.
idIntegerYY N NNJob result table row ID.
device-nameStringNY Y * YNDevice Name.
statusStringNY Y * YNStatus.
descriptionStringNY Y * YNDescription.
device-addressStringNY Y * YNDevice Address.
job-instance-idIntegerNY Y * NNJob Instance ID.

activate-modeled-device-device-init-request (vnd.net.juniper.space.device-management.activate-modeled-device-device-init-request;version=1)

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this activate-modeled-device-device-init-request node in the current node context. This link can be used to retrieve or operate on the currently referenced activate-modeled-device-device-init-request in the tree path.
connection-profileactivate-modeled-device-device-init-request.connectionProfileMORESTNY Y *  
static-ipStringNY Y Static IP address to be set to the device (Static Connection Profile).
subnet-idStringNY Y Subnet Prefix to be set to the device (Static Connection Profile).
gatewayStringNY Y Gateway to be set to the device (Static Connection Profile).
serial-number-validationBooleanNY Y Should serial number validation be performed.

Default: false.
user-nameStringNY Y * Username to authenticate with the device.
passwordStringNY Y Password to authenticate with the device.
key-basedBooleanNY Y Should key based authentication be performed.

Default: false.
serial-numberStringNY Y Serial number of the device, in case serial number validation is enabled.
Configuration-update-typeenum(Configuration-update-type)NY Y Should the configuration be updated manually or automatically. In manual application, the configlet will not be pushed onto the device during discovery.

Possible Values:
AUTOMATICAutomatic
MANUALManual
NOT_APPICABLENot Applicable

Default: AUTOMATIC.

activate-modeled-device-device-init-request.connectionProfileMOREST

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this connectionProfileMOREST node in the current node context. This link can be used to retrieve or operate on the currently referenced connectionProfileMOREST in the tree path.
@hrefString(URI)NY Y * Link to an external connectionProfileMOREST. Here, href points to the connectionProfileMOREST in the primary connectionProfileMOREST collection.

Hyperlink Template: /api/space/device-management/modeled-device-management/connection-profiles/{*ID}.
idIntegerYY N ID of the conneciton profile.
nameStringNY Y Name of the connection profile.

activate-modeled-device-space-init-request (vnd.net.juniper.space.device-management.activate-modeled-device-space-init-request;version=1)

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this activate-modeled-device-space-init-request node in the current node context. This link can be used to retrieve or operate on the currently referenced activate-modeled-device-space-init-request in the tree path.
hostStringNY Y * Hostname/IP address of the device.
user-nameStringNY Y * Username to authenticate with the device.
passwordStringNY Y Password to authenticate with the device.
key-basedBooleanNY Y Should key based authentication be performed.

Default: false.
use-natBooleanNY Y Is JNAP server behind NAT [NAT enabled].

Default: false.
create-new-userBooleanNY Y Should a new user be created on the device.

Default: false.
new-user-nameStringNY Y User name for the new user.
new-user-passwordStringNY Y Password for the new user.
new-user-key-basedBooleanNY Y Perform key based authentication for the new user.

Default: false.
serial-number-validationBooleanNY Y Should serial number validation be performed.

Default: false.
serial-numberStringNY Y Serial number of the device, in case serial number validation is enabled.
configuration-update-typeenum(configuration-update-type)NY Y Should the configuration be updated manually or automatically.In manual application, the configlet will not be pushed onto the device during discovery.

Possible Values:
AUTOMATICAutomatic
MANUALManual
NOT_APPICABLENot Applicable

Default: AUTOMATIC.

active-users (vnd.net.juniper.space.user-management.active-users;version=3)

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this active-users node in the current node context. This link can be used to retrieve or operate on the currently referenced active-users in the tree path.
@totalIntegerYY N Total number of active-users in the API result set. If paging parameters are used in the query to limit the result set size, then total represents the total number of active-users in all the pages of the result set.
active-useractive-users.activeUser[]NY Y *  

active-users.activeUser

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)YY N NNLink to this activeUser node in the current node context. This link can be used to retrieve or operate on the currently referenced activeUser in the tree path.

Hyperlink Template: /api/space/user-management/active-users/{*ID}.
@hrefString(URI)YY N NNLink to an external activeUser. Here, href points to the activeUser in the primary active-users collection.

Hyperlink Template: /api/space/user-management/active-users/{*ID}.
@totalIntegerYY N NNTotal number of gen_active-users-active-users in the API result set. If paging parameters are used in the query to limit the result set size, then total represents the total number of gen_active-users-active-users in all the pages of the result set.

Default: 0.
domain-nameStringYY N NNDomain Name.
job-statusStringYY N NNJob Status.
job-idIntegerYY N NNJob ID.
session-start-timeStringYY N YYSession Start Time.
idIntegerYY N YYActiveUser ID.
ip-addressStringYY N YYUser IP Addr.
user-nameStringYY N YYUser Name.
fabric-node-nameStringYY N YYFabric Node Name.
session-durationStringYY N NNLogin Duration.

active-user-session (vnd.net.juniper.space.user-management.active-user-session;version=1)

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)NY Y Link to this active-user-session node in the current node context. This link can be used to retrieve or operate on the currently referenced active-user-session in the tree path.
idIntegerNY Y The HREF ID for this session.
user-nameStringNY Y * The Session user name.
ip-addressStringNY Y * The user's source address.
session-start-timeStringNY Y * The time when the session was started.
fabric-node-nameStringNY Y * user logged-in node name.
useractive-user-session.userNY Y * The user for this session.

active-user-session.user

Field NameTypeRead OnlyGETPUT / POSTDescription
@hrefString(URI)NY Y * Link to an external user. Here, href points to the user in the primary user collection.
@uriString(URI)NY Y Link to this user node in the current node context. This link can be used to retrieve or operate on the currently referenced user in the tree path.
idIntegerNY Y The unique identifier for the user.
nameStringNY Y The user's name.
primaryEmailStringNY Y The user's primary email.
firstNameStringNY Y The user's first name.
lastNameStringNY Y The user's last name.

active-user-sessions (vnd.net.juniper.space.user-management.active-user-sessions;version=1)

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)NY Y * Link to this active-user-sessions node in the current node context. This link can be used to retrieve or operate on the currently referenced active-user-sessions in the tree path.
@sizeIntegerNY Y * The size of records returned by the API.
@totalIntegerNY Y * Total number of active-user-sessions in the API result set. If paging parameters are used in the query to limit the result set size, then total represents the total number of active-user-sessions in all the pages of the result set.
active-user-sessionactive-user-sessions.activeUserSession[]NY Y * A single session.

active-user-sessions.activeUserSession

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
idIntegerNY Y YYA unique identifier for the user session.
user-nameStringNY Y NNThe user name of the active session.
domain-nameStringNY Y NNDomain name of the active session.
ip-addressStringNY Y YYThe IP address of the user session.
session-start-timeStringNY Y NNThe session start time of the active session.
session-durationStringNY Y NNThe session duration of the active session.
fabric-node-nameStringNY Y YYuser logged-in node name.
uriStringNY Y NNThe URI link to this active user session.
hrefStringNY Y NNThe HREF link to this active user session.
jobIdintNY Y NNThe Job Id to this active user session.
jobStatusStringNY Y NNThe Job Status to this active user session.

active-user-sessions-by-names-request (vnd.net.juniper.space.user-management.active-user-sessions-by-names-request;version=3)

Field NameTypeRead OnlyGETPUT / POSTDescription
users-name-listactive-user-sessions-by-names-request.usersNameListsNY Y  

active-user-sessions-by-names-request.usersNameLists

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this usersNameLists node in the current node context. This link can be used to retrieve or operate on the currently referenced usersNameLists in the tree path.
users-name-listString[]NY Y * Users Name Lists.

add-database-fabric-node-request (vnd.api.space.fabric-management.fabric-nodes.add-database-fabric-node-request;version=2)

Information about Database Node

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this add-database-fabric-node-request node in the current node context. This link can be used to retrieve or operate on the currently referenced add-database-fabric-node-request in the tree path.
primary-nodeadd-database-fabric-node-request.primaryNodeInfoNY Y * Information about the primary Database Node which has to be added to the fabric.
vipadd-database-fabric-node-request.virtualIPNY Y * The VIP IP address of the Database Node. The IP version will be validated based on current server configuration.
secondary-nodeadd-database-fabric-node-request.secondaryNodeInfoNY Y * Information about the secondary Database Node which has to be added to the fabric.

add-database-fabric-node-request.primaryNodeInfo

Information about the primary Database Node which has to be added to the fabric.

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this primaryNodeInfo node in the current node context. This link can be used to retrieve or operate on the currently referenced primaryNodeInfo in the tree path.
usernameStringNY Y * The login user name used by the Junos Space server to login to Space Node while adding the node to the fabric.
passwordStringNY Y * The login password used by the Junos Space server to login to Space Node while adding the node to the fabric.
nameStringNY Y * Name of the node.
ipStringNY Y * The IPv4 / IPv6 address of the node. This IP version will be validated based on current server configuration.
fingerprintStringNY Y Fingerprint of the node.

add-database-fabric-node-request.virtualIP

The VIP IP address of the Database Node. The IP version will be validated based on current server configuration.

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this virtualIP node in the current node context. This link can be used to retrieve or operate on the currently referenced virtualIP in the tree path.
ip-v4-addressStringNY Y IPv4 VIP address.
ip-v6-addressStringNY Y IPv6 VIP address.

add-database-fabric-node-request.secondaryNodeInfo

Information about the secondary Database Node which has to be added to the fabric.

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this secondaryNodeInfo node in the current node context. This link can be used to retrieve or operate on the currently referenced secondaryNodeInfo in the tree path.
usernameStringNY Y * The login user name used by the Junos Space server to login to Space Node while adding the node to the fabric.
passwordStringNY Y * The login password used by the Junos Space server to login to Space Node while adding the node to the fabric.
nameStringNY Y * Name of the node.
ipStringNY Y * The IPv4 / IPv6 address of the node. This IP version will be validated based on current server configuration.
fingerprintStringNY Y Fingerprint of the node.

add-device-discovery-rule-by-csv-request (vnd.net.juniper.space.device-management.add-device-discovery-rule-by-csv-request;version=6)

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this add-device-discovery-rule-by-csv-request node in the current node context. This link can be used to retrieve or operate on the currently referenced add-device-discovery-rule-by-csv-request in the tree path.
idIntegerYY N DeviceDiscoveryRuleByCSV ID.
discovery-profile-nameStringNY Y * Discovery profile name.
target-detailsStringNY Y * Target details (10.155.60.1, 10.155.60.1-10.155.60.10, 10.155.60.1/24, Sunnyvale-ISG, sample_discovery.csv).
use-pingBooleanNY Y * usePing flag.

Default: false.
use-natBooleanNY Y * useNAT flag.

Default: false.
sharableBooleanNY Y Profile sharable status.

Default: true.
use-snmpBooleanNY Y * useSnmp flag.

Default: false.
device-targetsadd-device-discovery-rule-by-csv-request.deviceTargetsNY Y *  
device-snmp-detailsadd-device-discovery-rule-by-csv-request.deviceSnmpDetailNY Y *  
device-snmp-versionenum(device-snmp-version)NY Y * SNMP version.

Possible Values:
NOT_APPLICABLEN/A
SNMPV1V2C 
SNMPV3 
.
discovery-action-additional-paramsadd-device-discovery-rule-by-csv-request.discoveryActionParamsNY Y Discovery Action additional parameter.

add-device-discovery-rule-by-csv-request.deviceTargets

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this deviceTargets node in the current node context. This link can be used to retrieve or operate on the currently referenced deviceTargets in the tree path.

Hyperlink Template: /device-targets.
device-targetadd-device-discovery-rule-by-csv-request.deviceTargets.deviceTarget[]NY Y *  

add-device-discovery-rule-by-csv-request.deviceTargets.deviceTarget

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)YY N NNLink to this deviceTarget node in the current node context. This link can be used to retrieve or operate on the currently referenced deviceTarget in the tree path.
idIntegerYY N NNId of device Target.
device-ssh-credentialsadd-device-discovery-rule-by-csv-request.deviceTargets.deviceTarget.deviceSshCredentialsNY Y NN 
upper-ipStringNY Y * NNupper ip address of a network to be discovered.
device-fingerprintsadd-device-discovery-rule-by-csv-request.deviceTargets.deviceTarget.deviceFingerprintsNY Y NN 
lower-ipStringNY Y * NNLower ip address of a network to be discovered.
host-nameStringNY Y * NNHost name of device to be discovered.
subnet-maskStringNY Y * NNSub-net mask of the above mentioned network.
base-ipStringNY Y * NNNetwork ip of a network to be discovered.
tagsadd-device-discovery-rule-by-csv-request.deviceTargets.deviceTarget.tagListsNY Y NN 
ip-addressStringNY Y * NNip-address of device to be discovered.

add-device-discovery-rule-by-csv-request.deviceTargets.deviceTarget.deviceSshCredentials

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this deviceSshCredentials node in the current node context. This link can be used to retrieve or operate on the currently referenced deviceSshCredentials in the tree path.
@totalIntegerYY N Total number of gen_add-device-discovery-rule-by-csv-request-device-targets-device-targets-device-ssh-credentials in the API result set. If paging parameters are used in the query to limit the result set size, then total represents the total number of gen_add-device-discovery-rule-by-csv-request-device-targets-device-targets-device-ssh-credentials in all the pages of the result set.
device-ssh-credentialadd-device-discovery-rule-by-csv-request.deviceTargets.deviceTarget.deviceSshCredentials.deviceSshCredential[]NY Y *  

add-device-discovery-rule-by-csv-request.deviceTargets.deviceTarget.deviceSshCredentials.deviceSshCredential

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)YY N NNLink to this deviceSshCredential node in the current node context. This link can be used to retrieve or operate on the currently referenced deviceSshCredential in the tree path.
idIntegerYY N NNDevice credential id.
usernameStringNY Y * NNName of user on the node used for authentication while discovery.
pass-phraseStringNY Y NNPass Phrase.
credential-typeenum(credential-type)NY Y NNCredential Type.

Possible Values:
CREDENTIAL_BASEDCredential Based
KEY_BASEDKey Based
CUSTOM_KEY_BASEDCustom Key Based
.
private-keyStringNY Y NNPrivate Key.
keybasedBooleanNY Y * NNTrue to enable key-based authentication. Password not need if this is true.

Default: false.
passwordStringNY Y * NNPassword for authentication.

add-device-discovery-rule-by-csv-request.deviceTargets.deviceTarget.deviceFingerprints

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this deviceFingerprints node in the current node context. This link can be used to retrieve or operate on the currently referenced deviceFingerprints in the tree path.
@totalIntegerYY N Total number of gen_add-device-discovery-rule-by-csv-request-device-targets-device-targets-device-fingerprints in the API result set. If paging parameters are used in the query to limit the result set size, then total represents the total number of gen_add-device-discovery-rule-by-csv-request-device-targets-device-targets-device-fingerprints in all the pages of the result set.
device-fingerprintadd-device-discovery-rule-by-csv-request.deviceTargets.deviceTarget.deviceFingerprints.deviceTargetFingerprint[]NY Y *  

add-device-discovery-rule-by-csv-request.deviceTargets.deviceTarget.deviceFingerprints.deviceTargetFingerprint

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)YY N NNLink to this deviceTargetFingerprint node in the current node context. This link can be used to retrieve or operate on the currently referenced deviceTargetFingerprint in the tree path.
idIntegerYY N NNId of the finger print entity.
host-nameStringNY Y * NNName of the node.
fingerprintStringNY Y * NNdevice fingerprint.

add-device-discovery-rule-by-csv-request.deviceTargets.deviceTarget.tagLists

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this tagLists node in the current node context. This link can be used to retrieve or operate on the currently referenced tagLists in the tree path.
tagString[]NY Y * Tag name.

add-device-discovery-rule-by-csv-request.deviceSnmpDetail

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this deviceSnmpDetail node in the current node context. This link can be used to retrieve or operate on the currently referenced deviceSnmpDetail in the tree path.
authentication-passwordStringNY Y * Password for SNMPv3 authentication.
idIntegerYY N Device SNMP details id.
privacy-passwordStringNY Y * key word to be used for encryption.
snmpv1v2c-communityStringNY Y * SNMPV1/V2C Community name.
user-nameStringNY Y * SNMPV3 username.
snmp-auth-typeenum(snmp-auth-type)NY Y * Authentication type of SNMPv3 Possible values : MD5, SHA1 or NONE;.

Possible Values:
MD5 
SHA1 
NONE 
.
privacy-typeenum(privacy-type)NY Y * Encryption methods to be used while discovery Possible values: AES128, AES192, AES256, DES or NONE.

Possible Values:
AES128 
AES192 
AES256 
DES 
NONE 
.

add-device-discovery-rule-by-csv-request.discoveryActionParams

Discovery Action additional parameter

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this discoveryActionParams node in the current node context. This link can be used to retrieve or operate on the currently referenced discoveryActionParams in the tree path.
discovery-action-additional-paramadd-device-discovery-rule-by-csv-request.discoveryActionParams.discoveryTriggerActionParam[]NY Y * Discovery Action additional parameter.

add-device-discovery-rule-by-csv-request.discoveryActionParams.discoveryTriggerActionParam

Discovery Action additional parameter

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)YY N NNLink to this discoveryTriggerActionParam node in the current node context. This link can be used to retrieve or operate on the currently referenced discoveryTriggerActionParam in the tree path.
parameterStringNY Y * NNParameter will act as a key.
parameter-valueStringNY Y * NNParameterValue will act as a value for the key.

add-device-discovery-rule-by-host-name-request (vnd.net.juniper.space.device-management.add-device-discovery-rule-by-host-name-request;version=6)

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this add-device-discovery-rule-by-host-name-request node in the current node context. This link can be used to retrieve or operate on the currently referenced add-device-discovery-rule-by-host-name-request in the tree path.
idIntegerYY N DeviceDiscoveryRuleByHostName ID.
discovery-profile-nameStringNY Y * Discovery profile name.
use-pingBooleanNY Y * usePing flag.

Default: false.
use-natBooleanNY Y * useNAT flag.

Default: false.
sharableBooleanNY Y * Profile sharable status.

Default: true.
use-snmpBooleanNY Y * useSnmp flag.

Default: false.
device-targetsadd-device-discovery-rule-by-host-name-request.deviceTargetsNY Y *  
device-snmp-detailsadd-device-discovery-rule-by-host-name-request.deviceSnmpDetailNY Y *  
device-snmp-versionenum(device-snmp-version)NY Y * SNMP version.

Possible Values:
NOT_APPLICABLEN/A
SNMPV1V2C 
SNMPV3 
.
discovery-action-additional-paramsadd-device-discovery-rule-by-host-name-request.discoveryActionParamsNY Y Discovery Action additional parameter configuration.

add-device-discovery-rule-by-host-name-request.deviceTargets

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this deviceTargets node in the current node context. This link can be used to retrieve or operate on the currently referenced deviceTargets in the tree path.
device-targetadd-device-discovery-rule-by-host-name-request.deviceTargets.deviceTarget[]NY Y *  

add-device-discovery-rule-by-host-name-request.deviceTargets.deviceTarget

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)YY N NNLink to this deviceTarget node in the current node context. This link can be used to retrieve or operate on the currently referenced deviceTarget in the tree path.
idIntegerYY N NNId of device Target.
host-nameStringNY Y * NNHost name of device to be discovered.
device-ssh-credentialsadd-device-discovery-rule-by-host-name-request.deviceTargets.deviceTarget.deviceSshCredentialsNY Y NN 
device-fingerprintsadd-device-discovery-rule-by-host-name-request.deviceTargets.deviceTarget.deviceFingerprintsNY Y NN 

add-device-discovery-rule-by-host-name-request.deviceTargets.deviceTarget.deviceSshCredentials

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this deviceSshCredentials node in the current node context. This link can be used to retrieve or operate on the currently referenced deviceSshCredentials in the tree path.
@totalIntegerYY 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. If paging parameters are used in the query to limit the result set size, then total represents the total number of gen_add-device-discovery-rule-by-host-name-request-device-targets-device-targets-device-ssh-credentials in all the pages of the result set.
device-ssh-credentialadd-device-discovery-rule-by-host-name-request.deviceTargets.deviceTarget.deviceSshCredentials.deviceSshCredential[]NY Y *  

add-device-discovery-rule-by-host-name-request.deviceTargets.deviceTarget.deviceSshCredentials.deviceSshCredential

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)YY N NNLink to this deviceSshCredential node in the current node context. This link can be used to retrieve or operate on the currently referenced deviceSshCredential in the tree path.
idIntegerYY N NNDevice credential id.
usernameStringNY Y * NNName of user on the node used for authentication while discovery.
keybasedBooleanNY Y * NNTrue to enable key-based authentication. Password not need if this is true.

Default: false.
credential-typeenum(credential-type)NY Y NNCredential Type.

Possible Values:
CREDENTIAL_BASEDCredential Based
KEY_BASEDKey Based
CUSTOM_KEY_BASEDCustom Key Based
.
passwordStringNY Y * NNPassword for authentication.
pass-phraseStringNY Y NNPass Phrase.
private-keyStringNY Y NNPrivate Key.

add-device-discovery-rule-by-host-name-request.deviceTargets.deviceTarget.deviceFingerprints

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this deviceFingerprints node in the current node context. This link can be used to retrieve or operate on the currently referenced deviceFingerprints in the tree path.
@totalIntegerYY N Total number of gen_add-device-discovery-rule-by-host-name-request-device-targets-device-targets-device-fingerprints in the API result set. If paging parameters are used in the query to limit the result set size, then total represents the total number of gen_add-device-discovery-rule-by-host-name-request-device-targets-device-targets-device-fingerprints in all the pages of the result set.
device-fingerprintadd-device-discovery-rule-by-host-name-request.deviceTargets.deviceTarget.deviceFingerprints.deviceTargetFingerprint[]NY Y *  

add-device-discovery-rule-by-host-name-request.deviceTargets.deviceTarget.deviceFingerprints.deviceTargetFingerprint

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)YY N NNLink to this deviceTargetFingerprint node in the current node context. This link can be used to retrieve or operate on the currently referenced deviceTargetFingerprint in the tree path.
idIntegerYY N NNId of the finger print entity.
host-nameStringNY Y * NNName of the node.
fingerprintStringNY Y * NNdevice fingerprint.

add-device-discovery-rule-by-host-name-request.deviceSnmpDetail

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this deviceSnmpDetail node in the current node context. This link can be used to retrieve or operate on the currently referenced deviceSnmpDetail in the tree path.
authentication-passwordStringNY Y * Password for SNMPv3 authentication.
idIntegerYY N Device SNMP details id.
privacy-passwordStringNY Y * key word to be used for encryption.
snmpv1v2c-communityStringNY Y * SNMPV1/V2C Community name.
user-nameStringNY Y * SNMPV3 username.
snmp-auth-typeenum(snmp-auth-type)NY Y * Authentication type of SNMPv3 Possible values : MD5, SHA1 or NONE;.

Possible Values:
MD5 
SHA1 
NONE 
.
privacy-typeenum(privacy-type)NY Y * Encryption methods to be used while discovery Possible values: AES128, AES192, AES256, DES or NONE.

Possible Values:
AES128 
AES192 
AES256 
DES 
NONE 
.

add-device-discovery-rule-by-host-name-request.discoveryActionParams

Discovery Action additional parameter configuration

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this discoveryActionParams node in the current node context. This link can be used to retrieve or operate on the currently referenced discoveryActionParams in the tree path.
discovery-action-additional-paramadd-device-discovery-rule-by-host-name-request.discoveryActionParams.discoveryTriggerActionParam[]NY Y * Discovery Action additional parameter.

add-device-discovery-rule-by-host-name-request.discoveryActionParams.discoveryTriggerActionParam

Discovery Action additional parameter

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)YY N NNLink to this discoveryTriggerActionParam node in the current node context. This link can be used to retrieve or operate on the currently referenced discoveryTriggerActionParam in the tree path.
parameterStringNY Y * NNParameter will act as a key.
parameter-valueStringNY Y * NNParameterValue will act as a value for the key.

add-device-discovery-rule-by-ip-hostname-request (vnd.net.juniper.space.device-management.add-device-discovery-rule-by-ip-hostname-request;version=6)

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this add-device-discovery-rule-by-ip-hostname-request node in the current node context. This link can be used to retrieve or operate on the currently referenced add-device-discovery-rule-by-ip-hostname-request in the tree path.
idIntegerYY N DeviceDiscoveryRuleByIPHostname ID.
target-detailsStringNY Y Target details (10.155.60.1, 10.155.60.1-10.155.60.10, 10.155.60.1/24, Sunnyvale-ISG, sample_discovery.csv).
discovery-profile-nameStringNY Y * Discovery profile name.
use-pingBooleanNY Y * usePing flag.

Default: false.
use-natBooleanNY Y * useNAT flag.

Default: false.
sharableBooleanNY Y Profile sharable status.

Default: true.
use-snmpBooleanNY Y * useSnmp flag.

Default: false.
device-targetsadd-device-discovery-rule-by-ip-hostname-request.deviceTargetsNY Y *  
device-snmp-versionenum(device-snmp-version)NY Y * SNMP version.

Possible Values:
NOT_APPLICABLEN/A
SNMPV1V2C 
SNMPV3 
.
device-snmp-detailsadd-device-discovery-rule-by-ip-hostname-request.deviceSnmpDetailNY Y *  

add-device-discovery-rule-by-ip-hostname-request.deviceTargets

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this deviceTargets node in the current node context. This link can be used to retrieve or operate on the currently referenced deviceTargets in the tree path.

Hyperlink Template: /device-targets.
device-targetadd-device-discovery-rule-by-ip-hostname-request.deviceTargets.deviceTarget[]NY Y *  

add-device-discovery-rule-by-ip-hostname-request.deviceTargets.deviceTarget

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)YY N NNLink to this deviceTarget node in the current node context. This link can be used to retrieve or operate on the currently referenced deviceTarget in the tree path.
idIntegerYY N NNId of device Target.
base-ipStringNY Y * NNNetwork ip of a network to be discovered.
subnet-maskStringNY Y * NNSub-net mask of the above mentioned network.
ip-addressStringNY Y * NNip-address of device to be discovered.
host-nameStringNY Y * NNHost name of device to be discovered.
device-ssh-credentialsadd-device-discovery-rule-by-ip-hostname-request.deviceTargets.deviceTarget.deviceSshCredentialsNY Y NN 
lower-ipStringNY Y * NNLower ip address of a network to be discovered.
upper-ipStringNY Y * NNupper ip address of a network to be discovered.
device-fingerprintsadd-device-discovery-rule-by-ip-hostname-request.deviceTargets.deviceTarget.deviceFingerprintsNY Y NN 

add-device-discovery-rule-by-ip-hostname-request.deviceTargets.deviceTarget.deviceSshCredentials

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this deviceSshCredentials node in the current node context. This link can be used to retrieve or operate on the currently referenced deviceSshCredentials in the tree path.

Hyperlink Template: /device-targets/device-ssh-credentials.
@totalIntegerYY 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. If paging parameters are used in the query to limit the result set size, then total represents the total number of gen_add-device-discovery-rule-by-ip-hostname-request-device-targets-device-targets-device-ssh-credentials in all the pages of the result set.
device-ssh-credentialadd-device-discovery-rule-by-ip-hostname-request.deviceTargets.deviceTarget.deviceSshCredentials.deviceSshCredential[]NY Y *  

add-device-discovery-rule-by-ip-hostname-request.deviceTargets.deviceTarget.deviceSshCredentials.deviceSshCredential

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)YY N NNLink to this deviceSshCredential node in the current node context. This link can be used to retrieve or operate on the currently referenced deviceSshCredential in the tree path.
idIntegerYY N NNDevice credential id.
usernameStringNY Y * NNName of user on the node used for authentication while discovery.
keybasedBooleanNY Y * NNTrue to enable key-based authentication. Password not need if this is true.

Default: false.
credential-typeenum(credential-type)NY Y NNCredential Type.

Possible Values:
CREDENTIAL_BASEDCredential Based
KEY_BASEDKey Based
CUSTOM_KEY_BASEDCustom Key Based
.
passwordStringNY Y * NNPassword for authentication.
pass-phraseStringNY Y NNPass Phrase.
private-keyStringNY Y NNPrivate Key.

add-device-discovery-rule-by-ip-hostname-request.deviceTargets.deviceTarget.deviceFingerprints

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this deviceFingerprints node in the current node context. This link can be used to retrieve or operate on the currently referenced deviceFingerprints in the tree path.

Hyperlink Template: /device-targets/device-fingerprints.
@totalIntegerYY N Total number of gen_add-device-discovery-rule-by-ip-hostname-request-device-targets-device-targets-device-fingerprints in the API result set. If paging parameters are used in the query to limit the result set size, then total represents the total number of gen_add-device-discovery-rule-by-ip-hostname-request-device-targets-device-targets-device-fingerprints in all the pages of the result set.
device-fingerprintadd-device-discovery-rule-by-ip-hostname-request.deviceTargets.deviceTarget.deviceFingerprints.deviceTargetFingerprint[]NY Y *  

add-device-discovery-rule-by-ip-hostname-request.deviceTargets.deviceTarget.deviceFingerprints.deviceTargetFingerprint

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)YY N NNLink to this deviceTargetFingerprint node in the current node context. This link can be used to retrieve or operate on the currently referenced deviceTargetFingerprint in the tree path.
idIntegerYY N NNId of the finger print entity.
fingerprintStringNY Y * NNdevice fingerprint.
host-nameStringNY Y * NNName of the node.

add-device-discovery-rule-by-ip-hostname-request.deviceSnmpDetail

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this deviceSnmpDetail node in the current node context. This link can be used to retrieve or operate on the currently referenced deviceSnmpDetail in the tree path.
authentication-passwordStringNY Y * Password for SNMPv3 authentication.
idIntegerYY N Device SNMP details id.
privacy-passwordStringNY Y * key word to be used for encryption.
snmpv1v2c-communityStringNY Y * SNMPV1/V2C Community name.
user-nameStringNY Y * SNMPV3 username.
snmp-auth-typeenum(snmp-auth-type)NY Y * Authentication type of SNMPv3 Possible values : MD5, SHA1 or NONE;.

Possible Values:
MD5 
SHA1 
NONE 
.
privacy-typeenum(privacy-type)NY Y * Encryption methods to be used while discovery Possible values: AES128, AES192, AES256, DES or NONE.

Possible Values:
AES128 
AES192 
AES256 
DES 
NONE 
.

add-device-discovery-rule-by-ip-range-request (vnd.net.juniper.space.device-management.add-device-discovery-rule-by-ip-range-request;version=6)

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this add-device-discovery-rule-by-ip-range-request node in the current node context. This link can be used to retrieve or operate on the currently referenced add-device-discovery-rule-by-ip-range-request in the tree path.
idIntegerYY N DeviceDiscoveryRuleByIPRange ID.
discovery-profile-nameStringNY Y * Discovery profile name.
use-pingBooleanNY Y * usePing flag.

Default: false.
use-natBooleanNY Y * useNAT flag.

Default: false.
sharableBooleanNY Y * Profile sharable status.

Default: true.
use-snmpBooleanNY Y * useSnmp flag.

Default: false.
device-targetsadd-device-discovery-rule-by-ip-range-request.deviceTargetsNY Y *  
device-snmp-detailsadd-device-discovery-rule-by-ip-range-request.deviceSnmpDetailNY Y *  
device-snmp-versionenum(device-snmp-version)NY Y * SNMP version.

Possible Values:
NOT_APPLICABLEN/A
SNMPV1V2C 
SNMPV3 
.
discovery-action-additional-paramsadd-device-discovery-rule-by-ip-range-request.discoveryActionParamsNY Y Discovery Action additional parameter configuration.

add-device-discovery-rule-by-ip-range-request.deviceTargets

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this deviceTargets node in the current node context. This link can be used to retrieve or operate on the currently referenced deviceTargets in the tree path.
device-targetadd-device-discovery-rule-by-ip-range-request.deviceTargets.deviceTarget[]NY Y *  

add-device-discovery-rule-by-ip-range-request.deviceTargets.deviceTarget

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)YY N NNLink to this deviceTarget node in the current node context. This link can be used to retrieve or operate on the currently referenced deviceTarget in the tree path.
idIntegerYY N NNId of device Target.
lower-ipStringNY Y * NNLower ip address of a network to be discovered.
upper-ipStringNY Y * NNupper ip address of a network to be discovered.
device-ssh-credentialsadd-device-discovery-rule-by-ip-range-request.deviceTargets.deviceTarget.deviceSshCredentialsNY Y NN 
device-fingerprintsadd-device-discovery-rule-by-ip-range-request.deviceTargets.deviceTarget.deviceFingerprintsNY Y NN 

add-device-discovery-rule-by-ip-range-request.deviceTargets.deviceTarget.deviceSshCredentials

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this deviceSshCredentials node in the current node context. This link can be used to retrieve or operate on the currently referenced deviceSshCredentials in the tree path.
@totalIntegerYY 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. If paging parameters are used in the query to limit the result set size, then total represents the total number of gen_add-device-discovery-rule-by-ip-range-request-device-targets-device-targets-device-ssh-credentials in all the pages of the result set.
device-ssh-credentialadd-device-discovery-rule-by-ip-range-request.deviceTargets.deviceTarget.deviceSshCredentials.deviceSshCredential[]NY Y *  

add-device-discovery-rule-by-ip-range-request.deviceTargets.deviceTarget.deviceSshCredentials.deviceSshCredential

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)YY N NNLink to this deviceSshCredential node in the current node context. This link can be used to retrieve or operate on the currently referenced deviceSshCredential in the tree path.
idIntegerYY N NNDevice credential id.
usernameStringNY Y * NNName of user on the node used for authentication while discovery.
keybasedBooleanNY Y * NNTrue to enable key-based authentication. Password not need if this is true.

Default: false.
credential-typeenum(credential-type)NY Y NNCredential Type.

Possible Values:
CREDENTIAL_BASEDCredential Based
KEY_BASEDKey Based
CUSTOM_KEY_BASEDCustom Key Based
.
passwordStringNY Y * NNPassword for authentication.
pass-phraseStringNY Y NNPass Phrase.
private-keyStringNY Y NNPrivate Key.

add-device-discovery-rule-by-ip-range-request.deviceTargets.deviceTarget.deviceFingerprints

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this deviceFingerprints node in the current node context. This link can be used to retrieve or operate on the currently referenced deviceFingerprints in the tree path.
@totalIntegerYY N Total number of gen_add-device-discovery-rule-by-ip-range-request-device-targets-device-targets-device-fingerprints in the API result set. If paging parameters are used in the query to limit the result set size, then total represents the total number of gen_add-device-discovery-rule-by-ip-range-request-device-targets-device-targets-device-fingerprints in all the pages of the result set.
device-fingerprintadd-device-discovery-rule-by-ip-range-request.deviceTargets.deviceTarget.deviceFingerprints.deviceTargetFingerprint[]NY Y *  

add-device-discovery-rule-by-ip-range-request.deviceTargets.deviceTarget.deviceFingerprints.deviceTargetFingerprint

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)YY N NNLink to this deviceTargetFingerprint node in the current node context. This link can be used to retrieve or operate on the currently referenced deviceTargetFingerprint in the tree path.
idIntegerYY N NNId of the finger print entity.
host-nameStringNY Y * NNName of the node.
fingerprintStringNY Y * NNdevice fingerprint.

add-device-discovery-rule-by-ip-range-request.deviceSnmpDetail

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this deviceSnmpDetail node in the current node context. This link can be used to retrieve or operate on the currently referenced deviceSnmpDetail in the tree path.
authentication-passwordStringNY Y * Password for SNMPv3 authentication.
idIntegerYY N Device SNMP details id.
privacy-passwordStringNY Y * key word to be used for encryption.
snmpv1v2c-communityStringNY Y * SNMPV1/V2C Community name.
user-nameStringNY Y * SNMPV3 username.
snmp-auth-typeenum(snmp-auth-type)NY Y * Authentication type of SNMPv3 Possible values : MD5, SHA1 or NONE;.

Possible Values:
MD5 
SHA1 
NONE 
.
privacy-typeenum(privacy-type)NY Y * Encryption methods to be used while discovery Possible values: AES128, AES192, AES256, DES or NONE.

Possible Values:
AES128 
AES192 
AES256 
DES 
NONE 
.

add-device-discovery-rule-by-ip-range-request.discoveryActionParams

Discovery Action additional parameter configuration

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this discoveryActionParams node in the current node context. This link can be used to retrieve or operate on the currently referenced discoveryActionParams in the tree path.
discovery-action-additional-paramadd-device-discovery-rule-by-ip-range-request.discoveryActionParams.discoveryTriggerActionParam[]NY Y * Discovery Action additional parameter.

add-device-discovery-rule-by-ip-range-request.discoveryActionParams.discoveryTriggerActionParam

Discovery Action additional parameter

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)YY N NNLink to this discoveryTriggerActionParam node in the current node context. This link can be used to retrieve or operate on the currently referenced discoveryTriggerActionParam in the tree path.
parameterStringNY Y * NNParameter will act as a key.
parameter-valueStringNY Y * NNParameterValue will act as a value for the key.

add-device-discovery-rule-by-ip-request (vnd.net.juniper.space.device-management.add-device-discovery-rule-by-ip-request;version=6)

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this add-device-discovery-rule-by-ip-request node in the current node context. This link can be used to retrieve or operate on the currently referenced add-device-discovery-rule-by-ip-request in the tree path.
idIntegerYY N DeviceDiscoveryRuleByIp ID.
discovery-profile-nameStringNY Y * Discovery profile name.
use-pingBooleanNY Y * usePing flag.

Default: false.
use-natBooleanNY Y * useNAT flag.

Default: false.
sharableBooleanNY Y Profile sharable status.

Default: true.
use-snmpBooleanNY Y * useSnmp flag.

Default: false.
device-targetsadd-device-discovery-rule-by-ip-request.deviceTargetsNY Y  
device-snmp-detailsadd-device-discovery-rule-by-ip-request.deviceSnmpDetailNY Y *  
device-snmp-versionenum(device-snmp-version)NY Y * SNMP version.

Possible Values:
NOT_APPLICABLEN/A
SNMPV1V2C 
SNMPV3 
.
discovery-action-additional-paramsadd-device-discovery-rule-by-ip-request.discoveryActionParamsNY Y Discovery Action additional parameter configuration.

add-device-discovery-rule-by-ip-request.deviceTargets

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this deviceTargets node in the current node context. This link can be used to retrieve or operate on the currently referenced deviceTargets in the tree path.

Hyperlink Template: /device-targets.
device-targetadd-device-discovery-rule-by-ip-request.deviceTargets.deviceTarget[]NY Y *  

add-device-discovery-rule-by-ip-request.deviceTargets.deviceTarget

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)YY N NNLink to this deviceTarget node in the current node context. This link can be used to retrieve or operate on the currently referenced deviceTarget in the tree path.
idIntegerYY N NNId of device Target.
ip-addressStringNY Y * NNip-address of device to be discovered.
device-ssh-credentialsadd-device-discovery-rule-by-ip-request.deviceTargets.deviceTarget.deviceSshCredentialsNY Y NN 
device-fingerprintsadd-device-discovery-rule-by-ip-request.deviceTargets.deviceTarget.deviceFingerprintsNY Y NN 

add-device-discovery-rule-by-ip-request.deviceTargets.deviceTarget.deviceSshCredentials

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this deviceSshCredentials node in the current node context. This link can be used to retrieve or operate on the currently referenced deviceSshCredentials in the tree path.

Hyperlink Template: /device-ssh-credentials.
@totalIntegerYY 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. If paging parameters are used in the query to limit the result set size, then total represents the 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 all the pages of the result set.
device-ssh-credentialadd-device-discovery-rule-by-ip-request.deviceTargets.deviceTarget.deviceSshCredentials.deviceSshCredential[]NY Y *  

add-device-discovery-rule-by-ip-request.deviceTargets.deviceTarget.deviceSshCredentials.deviceSshCredential

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)YY N NNLink to this deviceSshCredential node in the current node context. This link can be used to retrieve or operate on the currently referenced deviceSshCredential in the tree path.
idIntegerYY N NNDevice credential id.
usernameStringNY Y * NNName of user on the node used for authentication while discovery.
keybasedBooleanNY Y * NNTrue to enable key-based authentication. Password not need if this is true.

Default: false.
credential-typeenum(credential-type)NY Y NNCredential Type.

Possible Values:
CREDENTIAL_BASEDCredential Based
KEY_BASEDKey Based
CUSTOM_KEY_BASEDCustom Key Based
.
passwordStringNY Y * NNPassword for authentication.
pass-phraseStringNY Y NNPass Phrase.
private-keyStringNY Y NNPrivate Key.

add-device-discovery-rule-by-ip-request.deviceTargets.deviceTarget.deviceFingerprints

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this deviceFingerprints node in the current node context. This link can be used to retrieve or operate on the currently referenced deviceFingerprints in the tree path.

Hyperlink Template: /device-fingerprints.
@totalIntegerYY 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. If paging parameters are used in the query to limit the result set size, then total represents the 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 all the pages of the result set.
device-fingerprintadd-device-discovery-rule-by-ip-request.deviceTargets.deviceTarget.deviceFingerprints.deviceTargetFingerprint[]NY Y *  

add-device-discovery-rule-by-ip-request.deviceTargets.deviceTarget.deviceFingerprints.deviceTargetFingerprint

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)YY N NNLink to this deviceTargetFingerprint node in the current node context. This link can be used to retrieve or operate on the currently referenced deviceTargetFingerprint in the tree path.
idIntegerYY N NNId of the finger print entity.
host-nameStringNY Y * NNName of the node.
fingerprintStringNY Y * NNdevice fingerprint.

add-device-discovery-rule-by-ip-request.deviceSnmpDetail

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this deviceSnmpDetail node in the current node context. This link can be used to retrieve or operate on the currently referenced deviceSnmpDetail in the tree path.
authentication-passwordStringNY Y * Password for SNMPv3 authentication.
idIntegerYY N Device SNMP details id.
privacy-passwordStringNY Y * key word to be used for encryption.
snmpv1v2c-communityStringNY Y * SNMPV1/V2C Community name.
user-nameStringNY Y * SNMPV3 username.
snmp-auth-typeenum(snmp-auth-type)NY Y * Authentication type of SNMPv3 Possible values : MD5, SHA1 or NONE;.

Possible Values:
MD5 
SHA1 
NONE 
.
privacy-typeenum(privacy-type)NY Y * Encryption methods to be used while discovery Possible values: AES128, AES192, AES256, DES or NONE.

Possible Values:
AES128 
AES192 
AES256 
DES 
NONE 
.

add-device-discovery-rule-by-ip-request.discoveryActionParams

Discovery Action additional parameter configuration

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this discoveryActionParams node in the current node context. This link can be used to retrieve or operate on the currently referenced discoveryActionParams in the tree path.
discovery-action-additional-paramadd-device-discovery-rule-by-ip-request.discoveryActionParams.discoveryTriggerActionParam[]NY Y * Discovery Action additional parameter.

add-device-discovery-rule-by-ip-request.discoveryActionParams.discoveryTriggerActionParam

Discovery Action additional parameter

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)YY N NNLink to this discoveryTriggerActionParam node in the current node context. This link can be used to retrieve or operate on the currently referenced discoveryTriggerActionParam in the tree path.
parameterStringNY Y * NNParameter will act as a key.
parameter-valueStringNY Y * NNParameterValue will act as a value for the key.

add-device-discovery-rule-by-ip-subnet-request (vnd.net.juniper.space.device-management.add-device-discovery-rule-by-ip-subnet-request;version=6)

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this add-device-discovery-rule-by-ip-subnet-request node in the current node context. This link can be used to retrieve or operate on the currently referenced add-device-discovery-rule-by-ip-subnet-request in the tree path.
idIntegerYY N DeviceDiscoveryRuleByIPSubnet ID.
discovery-profile-nameStringNY Y * Discovery profile name.
use-pingBooleanNY Y * usePing flag.

Default: false.
use-natBooleanNY Y * useNAT flag.

Default: false.
sharableBooleanNY Y * Profile sharable status.

Default: true.
use-snmpBooleanNY Y * useSnmp flag.

Default: false.
device-targetsadd-device-discovery-rule-by-ip-subnet-request.deviceTargetsNY Y *  
device-snmp-detailsadd-device-discovery-rule-by-ip-subnet-request.deviceSnmpDetailNY Y *  
device-snmp-versionenum(device-snmp-version)NY Y * SNMP version.

Possible Values:
NOT_APPLICABLEN/A
SNMPV1V2C 
SNMPV3 
.
discovery-action-additional-paramsadd-device-discovery-rule-by-ip-subnet-request.discoveryActionParamsNY Y Discovery Action additional parameter configuration.

add-device-discovery-rule-by-ip-subnet-request.deviceTargets

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this deviceTargets node in the current node context. This link can be used to retrieve or operate on the currently referenced deviceTargets in the tree path.
device-targetadd-device-discovery-rule-by-ip-subnet-request.deviceTargets.deviceTarget[]NY Y *  

add-device-discovery-rule-by-ip-subnet-request.deviceTargets.deviceTarget

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)YY N NNLink to this deviceTarget node in the current node context. This link can be used to retrieve or operate on the currently referenced deviceTarget in the tree path.
idIntegerYY N NNId of device Target.
base-ipStringNY Y * NNNetwork ip of a network to be discovered.
subnet-maskStringNY Y * NNSub-net mask of the above mentioned network.
device-ssh-credentialsadd-device-discovery-rule-by-ip-subnet-request.deviceTargets.deviceTarget.deviceSshCredentialsNY Y NN 
device-fingerprintsadd-device-discovery-rule-by-ip-subnet-request.deviceTargets.deviceTarget.deviceFingerprintsNY Y NN 

add-device-discovery-rule-by-ip-subnet-request.deviceTargets.deviceTarget.deviceSshCredentials

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this deviceSshCredentials node in the current node context. This link can be used to retrieve or operate on the currently referenced deviceSshCredentials in the tree path.
@totalIntegerYY 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. If paging parameters are used in the query to limit the result set size, then total represents the total number of gen_add-device-discovery-rule-by-ip-subnet-request-device-targets-device-targets-device-ssh-credentials in all the pages of the result set.
device-ssh-credentialadd-device-discovery-rule-by-ip-subnet-request.deviceTargets.deviceTarget.deviceSshCredentials.deviceSshCredential[]NY Y *  

add-device-discovery-rule-by-ip-subnet-request.deviceTargets.deviceTarget.deviceSshCredentials.deviceSshCredential

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)YY N NNLink to this deviceSshCredential node in the current node context. This link can be used to retrieve or operate on the currently referenced deviceSshCredential in the tree path.
idIntegerYY N NNDevice credential id.
usernameStringNY Y * NNName of user on the node used for authentication while discovery.
keybasedBooleanNY Y * NNTrue to enable key-based authentication. Password not need if this is true.

Default: false.
credential-typeenum(credential-type)NY Y NNCredential Type.

Possible Values:
CREDENTIAL_BASEDCredential Based
KEY_BASEDKey Based
CUSTOM_KEY_BASEDCustom Key Based
.
passwordStringNY Y * NNPassword for authentication.
pass-phraseStringNY Y NNPass Phrase.
private-keyStringNY Y NNPrivate Key.

add-device-discovery-rule-by-ip-subnet-request.deviceTargets.deviceTarget.deviceFingerprints

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this deviceFingerprints node in the current node context. This link can be used to retrieve or operate on the currently referenced deviceFingerprints in the tree path.
@totalIntegerYY N Total number of gen_add-device-discovery-rule-by-ip-subnet-request-device-targets-device-targets-device-fingerprints in the API result set. If paging parameters are used in the query to limit the result set size, then total represents the total number of gen_add-device-discovery-rule-by-ip-subnet-request-device-targets-device-targets-device-fingerprints in all the pages of the result set.
device-fingerprintadd-device-discovery-rule-by-ip-subnet-request.deviceTargets.deviceTarget.deviceFingerprints.deviceTargetFingerprint[]NY Y *  

add-device-discovery-rule-by-ip-subnet-request.deviceTargets.deviceTarget.deviceFingerprints.deviceTargetFingerprint

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)YY N NNLink to this deviceTargetFingerprint node in the current node context. This link can be used to retrieve or operate on the currently referenced deviceTargetFingerprint in the tree path.
idIntegerYY N NNId of the finger print entity.
host-nameStringNY Y * NNName of the node.
fingerprintStringNY Y * NNdevice fingerprint.

add-device-discovery-rule-by-ip-subnet-request.deviceSnmpDetail

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this deviceSnmpDetail node in the current node context. This link can be used to retrieve or operate on the currently referenced deviceSnmpDetail in the tree path.
authentication-passwordStringNY Y * Password for SNMPv3 authentication.
idIntegerYY N Device SNMP details id.
privacy-passwordStringNY Y * key word to be used for encryption.
snmpv1v2c-communityStringNY Y * SNMPV1/V2C Community name.
user-nameStringNY Y * SNMPV3 username.
snmp-auth-typeenum(snmp-auth-type)NY Y * Authentication type of SNMPv3 Possible values : MD5, SHA1 or NONE;.

Possible Values:
MD5 
SHA1 
NONE 
.
privacy-typeenum(privacy-type)NY Y * Encryption methods to be used while discovery Possible values: AES128, AES192, AES256, DES or NONE.

Possible Values:
AES128 
AES192 
AES256 
DES 
NONE 
.

add-device-discovery-rule-by-ip-subnet-request.discoveryActionParams

Discovery Action additional parameter configuration

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this discoveryActionParams node in the current node context. This link can be used to retrieve or operate on the currently referenced discoveryActionParams in the tree path.
discovery-action-additional-paramadd-device-discovery-rule-by-ip-subnet-request.discoveryActionParams.discoveryTriggerActionParam[]NY Y * Discovery Action additional parameter.

add-device-discovery-rule-by-ip-subnet-request.discoveryActionParams.discoveryTriggerActionParam

Discovery Action additional parameter

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)YY N NNLink to this discoveryTriggerActionParam node in the current node context. This link can be used to retrieve or operate on the currently referenced discoveryTriggerActionParam in the tree path.
parameterStringNY Y * NNParameter will act as a key.
parameter-valueStringNY Y * NNParameterValue will act as a value for the key.

add-jboss-fabric-node-request (vnd.api.space.fabric-management.fabric-nodes.add-jboss-fabric-node-request;version=2)

Information about the node which has to be added to the fabric.

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this add-jboss-fabric-node-request node in the current node context. This link can be used to retrieve or operate on the currently referenced add-jboss-fabric-node-request in the tree path.
passwordStringNY Y * The login password used by the Junos Space server to login to Space Node while adding the node to the fabric.
ipStringNY Y * The IPv4 / IPv6 address of the node. This IP version will be validated based on current server configuration.
usernameStringNY Y * The login user name used by the Junos Space server to login to Space Node while adding the node to the fabric.
nameStringNY Y * Name of the node.
fingerprintStringNY Y Fingerprint of the node.

add-more-devices-request (vnd.net.juniper.space.device-management.modeled-device-management.add-more-devices-request;version=1)

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this add-more-devices-request node in the current node context. This link can be used to retrieve or operate on the currently referenced add-more-devices-request in the tree path.

Hyperlink Template: /api/space/device-management/modeled-device-management/modeled-instances/{*ID}.
tag-nameStringNY Y Tag devices with this tag.
device-countIntegerNY Y * Number of devices, This will be overridden if deviceUnits are explicitly defined.
devicesadd-more-devices-request.deviceUnitsMOCollsNY Y List of modeled device which contains details like device-name, platform, os-version, serial-number.

add-more-devices-request.deviceUnitsMOColls

List of modeled device which contains details like device-name, platform, os-version, serial-number

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this deviceUnitsMOColls node in the current node context. This link can be used to retrieve or operate on the currently referenced deviceUnitsMOColls in the tree path.

Hyperlink Template: /api/space/device-management/modeled-device-management/modeled-instances/{*ID}/devices.
@totalIntegerYY N Total number of gen_deploy-instance-device-units-mo-coll in the API result set. If paging parameters are used in the query to limit the result set size, then total represents the total number of gen_deploy-instance-device-units-mo-coll in all the pages of the result set.
deviceadd-more-devices-request.deviceUnitsMOColls.deployDeviceUnit[]NY Y Modeled device which contains details like device-name, platform, os-version, serial-number.

add-more-devices-request.deviceUnitsMOColls.deployDeviceUnit

Modeled device which contains details like device-name, platform, os-version, serial-number

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)YY N NNLink to this deployDeviceUnit node in the current node context. This link can be used to retrieve or operate on the currently referenced deployDeviceUnit in the tree path.
device-nameStringNY Y NNName of the device unit.
platformStringNY Y NNThe platform of the device.
os-versionStringNY Y NNOS version of the device unit.
serial-numberStringNY Y NNSerial Number of device unit.

add-secondary-database-fabric-node-request (vnd.api.space.fabric-management.fabric-nodes.add-secondary-database-fabric-node-request;version=2)

Information about Database Node

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this add-secondary-database-fabric-node-request node in the current node context. This link can be used to retrieve or operate on the currently referenced add-secondary-database-fabric-node-request in the tree path.
secondary-nodeadd-secondary-database-fabric-node-request.secondaryNodeInfoNY Y * Information about the secondary Database Node which has to be added to the fabric.

add-secondary-database-fabric-node-request.secondaryNodeInfo

Information about the secondary Database Node which has to be added to the fabric.

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this secondaryNodeInfo node in the current node context. This link can be used to retrieve or operate on the currently referenced secondaryNodeInfo in the tree path.
usernameStringNY Y * The login user name used by the Junos Space server to login to Space Node while adding the node to the fabric.
passwordStringNY Y * The login password used by the Junos Space server to login to Space Node while adding the node to the fabric.
nameStringNY Y * Name of the node.
ipStringNY Y * The IPv4 / IPv6 address of the node. This IP version will be validated based on current server configuration.
fingerprintStringNY Y Fingerprint of the node.

add-special-fabric-node-request (vnd.api.space.fabric-management.fabric-nodes.add-special-fabric-node-request;version=2)

Information about the node which has to be added to the fabric.

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this add-special-fabric-node-request node in the current node context. This link can be used to retrieve or operate on the currently referenced add-special-fabric-node-request in the tree path.
ipStringNY Y * The IPv4 / IPv6 address of the node. This IP version will be validated based on current server configuration.
nameStringNY Y * Name of the node.
user-nameStringNY 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.
passwordStringNY Y The login password used by the Junos Space server to login to Special Node while adding the node to the fabric.
fingerprintStringNY Y Fingerprint of the node.

api-access-profile (vnd.net.juniper.space.user-management.api-access-profile;version=4)

Field NameTypeRead OnlyGETPUT / POSTPATCHDescription
@uriString(URI)YY N NLink to this api-access-profile node in the current node context. For primary collection members, href and uri are always the same.

Hyperlink Template: /api/space/user-management/api-access-profiles/{*ID}.
@hrefString(URI)YY N NLink to an external api-access-profile. Here, href points to the api-access-profile in the primary api-access-profiles collection.

Hyperlink Template: /api/space/user-management/api-access-profiles/{*ID}.
*idIntegerYY N NId of the api access profile.
nameStringNY Y * YName of the api access profile.
descriptionStringNY Y * YDescription for the api access profile.
predefinedBooleanYY N NThis flag is used to define whether this api access profile is predefined or not.

Default: false.
exec-rpc-rulesapi-access-profile.rpcRulesNY Y * Y 
domain-idIntegerYY N NDomain ID.

api-access-profile.rpcRules

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this rpcRules node in the current node context. This link can be used to retrieve or operate on the currently referenced rpcRules in the tree path.
exec-rpc-ruleapi-access-profile.rpcRules.aPIRPCRule[]NY Y *  

api-access-profile.rpcRules.aPIRPCRule

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)YY N NNLink to this aPIRPCRule node in the current node context. This link can be used to retrieve or operate on the currently referenced aPIRPCRule in the tree path.
ruleStringNY Y * NNRPC restriction rule.

Api-access-profile_patch (vnd.net.juniper.space.user-management.api-access-profile_patch;version=4)

api-access-profiles (vnd.net.juniper.space.user-management.api-access-profiles;version=4)

Field NameTypeRead OnlyGETPUT / POSTPATCHDescription
@uriString(URI)YY N NLink to this api-access-profiles node in the current node context. This link can be used to retrieve or operate on the currently referenced api-access-profiles in the tree path.
@totalIntegerYY N NTotal number of api-access-profiles in the API result set. If paging parameters are used in the query to limit the result set size, then total represents the total number of api-access-profiles in all the pages of the result set.
api-access-profileapi-access-profiles.aPIAccessProfile[]NY Y * Y 

api-access-profiles.aPIAccessProfile

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)YY N NNLink to this aPIAccessProfile node in the current node context. This link can be used to retrieve or operate on the currently referenced aPIAccessProfile in the tree path.

Hyperlink Template: /api/space/user-management/api-access-profiles/{*ID}.
@hrefString(URI)YY N NNLink to an external api-access-profile. Here, href points to the api-access-profile in the primary api-access-profiles collection.

Hyperlink Template: /api/space/user-management/api-access-profiles/{*ID}.
idIntegerYY N NNId of the api access profile.
nameStringNY Y * YYName of the api access profile.
descriptionStringNY Y * YYDescription for the api access profile.

Api-access-profiles_patch (vnd.net.juniper.space.user-management.api-access-profiles_patch;version=4)

applicable-configlets (vnd.net.juniper.space.device-management.applicable-configlets;version=5)

A collection of Configlets that are applicable for the Device Family

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this applicable-configlets node in the current node context. This link can be used to retrieve or operate on the currently referenced applicable-configlets in the tree path.
@totalIntegerYY N Total number of applicable-configlets in the API result set. If paging parameters are used in the query to limit the result set size, then total represents the total number of applicable-configlets in all the pages of the result set.
applicable-configletapplicable-configlets.cliConfigurationTemplate[]NY Y * Configlet that is applicable for the Device Family.

applicable-configlets.cliConfigurationTemplate

Configlet that is applicable for the Device Family

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@hrefString(URI)YY N NNLink to an external cliConfigurationTemplate. Here, href points to the cliConfigurationTemplate in the primary cliConfigurationTemplate collection.

Hyperlink Template: /api/space/configuration-management/cli-configlets/{*ID}.
idIntegerYY N NNConfiglet ID
Unique key of the configlet.
nameStringYY N YYConfiglet Name
The name of the configlet and it cannot exceed 255 characters. Allowable characters include dash (-), underscore (_), letters, and numbers and period (.).
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(.) characters..
categoryStringYY N YYCategory
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. Allowable characters include dash (-), underscore (_), letters, and numbers and period (.).
device-familyStringYY N YYDevice Family
The device family for which the configlet will be applicable for.
latest-versionStringYY N YYLatest Version
Latest version of the configlet.
last-modified-byStringYY N YYLast Modified user
The name of the user who modified the configlet at last.
creation-timeDateYY N YYCreation Time
The time when the configlet was created.
descriptionStringYY N NNDescription
Description of the configlet and it cannot exceed 2500 characters.
execution-typeStringYY N YYTypes of Execution
There are two types of execution types. Based on this type configlet would be available to apply on number of selected elements.
TypeDescription
SingleThe configlet can be applied to only one element at a time
GroupedThe configlet can be applied to multiple elements(devices) at a time
.
last-updated-timeDateYY N YYLast Modified Time
The time when the configlet was updated at last.
domain-idIntegerYY N NYDomain ID
ID of the domain for which the configlet belongs to.
domain-nameStringYY N NNDomain Name
Name of the domain for which the Cli-Configlet belongs to.

applicable-devices (vnd.net.juniper.space.configuration-management.applicable-devices;version=1)

A collection of Devices (excluding Unmanaged/Modeled Devices) for which the Configlet is applicable.

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this applicable-devices node in the current node context. This link can be used to retrieve or operate on the currently referenced applicable-devices in the tree path.
@totalIntegerYY N Total number of applicable-devices in the API result set. If paging parameters are used in the query to limit the result set size, then total represents the total number of applicable-devices in all the pages of the result set.
applicable-deviceapplicable-devices.device[]NY Y * A Device (excluding Unmanaged/Modeled Device) to which the Configlet is applicable.

applicable-devices.device

A Device (excluding Unmanaged/Modeled Device) to which the Configlet is applicable

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@hrefString(URI)YY N NNLink to an external device. Here, href points to the device in the primary device collection.

Hyperlink Template: /api/space/device-management/devices/{*ID}.
idIntegerYY N YYDevice ID
Unique key of the Device to which the configlet is applicable.
nameStringYY N YYDevice Name
Name of the Device for which the configlet is applicable.
ip-addressStringYY N YYIP Address
IP Address of the Device to which the configlet is applicable.
serial-numberStringYY N YYSerial Number
Serial Number of the Device to which the configlet is applicable.
connection-statusStringYY N YYConnection Status
Connection Status of the Device to which the configlet is applicable.
managed-statusStringYY N YYManaged Status
Managed Status of the Device to which the configlet is applicable.
device-familyStringYY N YYDevice Family
Family type of the Device to which the configlet is applicable.
platformStringYY N YYPlatform
Platform of the Device to which the configlet is applicable.
os-versionStringYY N YYOS Version
OS Version of the Device to which the configlet is applicable.
domain-idIntegerYY N NYDomain ID
ID of the Domain to which the Device belongs to.
domain-nameStringYY N NNDomain Name
Name of the Domain to which the Device belongs to.

application (vnd.net.juniper.space.application-management.application;version=3)

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this application node in the current node context. For primary collection members, href and uri are always the same.

Hyperlink Template: /api/space/application-management/applications/{*ID}.
@hrefString(URI)YY N Link to an external application. Here, href points to the application in the primary applications collection.

Hyperlink Template: /api/space/application-management/applications/{*ID}.
vendor-idStringNY Y * Vendor ID.
*idIntegerYY N Application ID.
nameStringYY N Application Name.
domain-idIntegerYY N Application's Domain ID.
titleStringYY N Application Title.
app-versionStringYY N Application Version.
app-sub-versionStringYY N Application Sub-Version.
release-typeStringYY N Application Release Type.
descriptionStringYY N Application Description.
domain-nameStringYY N Application's Domain Name.
min-platform-versionStringYY N Minimum Platform Version which supports this application. For SDK Applications, minimum platform version is 99.99.
server-groupStringYY N Name of server group on which the application is deployed.
settingsStringYY N config settings for application

Hyperlink Template: /api/space/application-management/applications/{*ID}/settings-config.

application (vnd.net.juniper.space.application-management.application;version=1)

The 'application' resource model represents details of an application and consists of the following fields:

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)NY Y Link to this application node in the current node context. This link can be used to retrieve or operate on the currently referenced application in the tree path.
idIntegerNY Y * Unique identifier for the application.
appNameStringNY Y * Name of the application.
appVersionStringNY Y * Version of the application.
appSubVersionStringNY Y Sub-version of the application.
titleStringNY Y * Title of the application.
descriptionStringNY Y * Description of the application.
releaseTypeStringNY Y Type of release for the application.
vendorIdStringNY Y Unique identifier for the application vendor.
vendorNameStringNY Y Name of the application vendor.
settingsStringNY Y * Configuration settings for the application.

applications (vnd.net.juniper.space.application-management.applications;version=3)

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this applications node in the current node context. This link can be used to retrieve or operate on the currently referenced applications in the tree path.
@totalIntegerYY N Total number of applications in the API result set. If paging parameters are used in the query to limit the result set size, then total represents the total number of applications in all the pages of the result set.
applicationapplications.application[]NY Y *  

applications.application

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)YY N NNLink to this application node in the current node context. This link can be used to retrieve or operate on the currently referenced application in the tree path.

Hyperlink Template: /api/space/application-management/applications/{*ID}.
@hrefString(URI)YY N NNLink to an external application. Here, href points to the application in the primary applications collection.

Hyperlink Template: /api/space/application-management/applications/{*ID}.
idIntegerYY N NNApplication ID.
nameStringYY N YYApplication Name.
domain-idIntegerYY N NYApplication's Domain ID.
release-typeStringYY N NNApplication Release Type.
titleStringYY N YYApplication Title.
descriptionStringYY N NNApplication Description.
app-versionStringYY N YYApplication Version.
app-sub-versionStringYY N YNApplication Sub-Version.
min-platform-versionStringYY N NNMinimum Platform Version which supports this application. For SDK Applications, minimum platform version is 99.99.
domain-nameStringYY N NNApplication's Domain Name.
server-groupStringYY N NNName of server group on which the application is deployed.

applications (vnd.net.juniper.space.application-management.applications;version=1)

The 'applications' resource model represents a collection of applications present in the system. The 'application' field of type 'JSApplicationConfig' represents pull-through data corresponding to an application. It consists of following fields:

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)NY Y Link to this applications node in the current node context. This link can be used to retrieve or operate on the currently referenced applications in the tree path.
@sizeIntegerNY Y Total number of applications available in the system.
applicationapplications.jSApplicationConfig[]NY Y * A collection of applications. Each object represents details about a respective application.

applications.jSApplicationConfig

The 'application' field of type 'JSApplicationConfig' consists of following pull-through fields:

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)NY Y NNLink to this jSApplicationConfig node in the current node context. This link can be used to retrieve or operate on the currently referenced jSApplicationConfig in the tree path.
@hrefString(URI)NY Y NNLink to an external jSApplicationConfig. Here, href points to the jSApplicationConfig in the primary jSApplicationConfig collection.
idIntegerNY Y * NN Unique identifier for an application
appNameStringNY Y * NN Name of the application
appVersionStringNY Y * YY Version of the application
titleStringNY Y * YY Title of the application
descriptionStringNY Y * NN Description of the application
releaseTypeStringNY Y NN Type of release for the application

apply-cli-configlet (vnd.net.juniper.space.device-management.apply-cli-configlet;version=5)

Apply CLI configlet's request from device

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this apply-cli-configlet node in the current node context. This link can be used to retrieve or operate on the currently referenced apply-cli-configlet in the tree path.
configletapply-cli-configlet.cliConfigurationTemplateNY Y * Configlet details.
cli-configlet-paramsapply-cli-configlet.cliConfigletParamsNY Y Configlet parameter details.

apply-cli-configlet.cliConfigurationTemplate

Configlet details

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this cliConfigurationTemplate node in the current node context. This link can be used to retrieve or operate on the currently referenced cliConfigurationTemplate in the tree path.
@hrefString(URI)NY Y * Link to an external cliConfigurationTemplate. Here, href points to the cliConfigurationTemplate in the primary cliConfigurationTemplate collection.

Hyperlink Template: /api/space/configuration-management/cli-configlets/{*ID}.
idIntegerYY N Unique key of the configlet.
nameStringYY N Name of the configlet
The Name cannot exceed 255 characters. Allowable characters include dash (-), underscore (_), letters, and numbers and period (.).
You cannot have two configlets with the same name.

apply-cli-configlet.cliConfigletParams

Configlet parameter details

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this cliConfigletParams node in the current node context. This link can be used to retrieve or operate on the currently referenced cliConfigletParams in the tree path.
cli-configlet-paramapply-cli-configlet.cliConfigletParams.configletParamForNBI[]NY Y * Configlet parameter.

apply-cli-configlet.cliConfigletParams.configletParamForNBI

Configlet parameter

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)YY N NNLink to this configletParamForNBI node in the current node context. This link can be used to retrieve or operate on the currently referenced configletParamForNBI in the tree path.
parameterapply-cli-configlet.cliConfigletParams.configletParamForNBI.paramForNBINY Y * NNParameter details.
parameter-valueStringNY Y * NNParameter Value.

apply-cli-configlet.cliConfigletParams.configletParamForNBI.paramForNBI

Parameter
Details of the parameter

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this paramForNBI node in the current node context. This link can be used to retrieve or operate on the currently referenced paramForNBI in the tree path.
@hrefString(URI)NY Y * Link to an external paramForNBI. Here, href points to the paramForNBI in the primary paramForNBI collection.

Hyperlink Template: /api/space/configuration-management/cli-configlets/{*ID}/cli-configlet-params/{*ID}.
param-idIntegerYY N Configlet Parameter ID
Unique Id for the configlet parameter.
Default: 0.

Default: 0.
nameStringYY N Parameter Name
Name of the parameter.
configlet-idIntegerYY N Configlet ID
Unique Id for the configlet.

apply-cli-configlet-job-result (vnd.net.juniper.space.configuration-management.apply-cli-configlet-job-result;version=2)

Apply Cli Configlet job result detail

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this apply-cli-configlet-job-result node in the current node context. This link can be used to retrieve or operate on the currently referenced apply-cli-configlet-job-result in the tree path.

Hyperlink Template: /api/space/configuration-management/apply-cli-configlet-job-results/{*ID}.
@hrefString(URI)YY N Link to an external apply-cli-configlet-job-result. Here, href points to the apply-cli-configlet-job-result in the primary apply-cli-configlet-job-result collection.

Hyperlink Template: /api/space/configuration-management/apply-cli-configlet-job-results/{*ID}.
applied-configurationStringNY Y * Applied Configuration.
status-stringStringNY Y * Status String.
end-timeDateNY Y End Time.
cli-template-nameStringNY Y * Cli Template Name.
params-detailssapply-cli-configlet-job-result.paramsDetailssesNY Y Collection of Configlet Parameters applied on the Device.
*idIntegerYY N Job result table row ID.
start-timeDateNY Y * Start Time.
cli-configlet-mgmt-job-statusenum(cli-configlet-mgmt-job-status)NY Y * Cli Configlet Mgmt Job Status.

Possible Values:
FAILEDFailed
SUCCESSSuccess
INPROGRESSInprogress
NOTSTARTEDScheduled
NOOPERATIONNo-Operation
CREATEDCreated
APPROVEDApproved
REJECTEDRejected
.
post-configurationBooleanNY Y * Post Configuration.

Default: false.
categoryStringNY Y * Category.
device-nameStringNY Y * Device Name.
cli-template-idIntegerNY Y * Cli Template ID.
descriptionStringNY Y Description.
job-remarksStringNY Y * Job Remarks.
contextStringNY Y * Context.
postparametersBooleanNY Y * Postparameters.

Default: false.
job-percentage-completedDoubleNY Y * Job Percentage Completed.
job-instance-idIntegerNY Y * Job Instance ID.
device-idIntegerNY Y * Device ID.

apply-cli-configlet-job-result.paramsDetailsses

Collection of Configlet Parameters applied on the Device

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this paramsDetailsses node in the current node context. This link can be used to retrieve or operate on the currently referenced paramsDetailsses in the tree path.

Hyperlink Template: /api/space/configuration-management/apply-cli-configlet-job-results/{*ID}/params-detailss.
applied-params-detailsapply-cli-configlet-job-result.paramsDetailsses.appliedParamsDetails[]NY Y * Configlet Parameters applied on the Device.

apply-cli-configlet-job-result.paramsDetailsses.appliedParamsDetails

Configlet Parameters applied on the Device

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)YY N NNLink to this appliedParamsDetails node in the current node context. This link can be used to retrieve or operate on the currently referenced appliedParamsDetails in the tree path.
param-valueStringNY Y * NNParam Value.
param-nameStringNY Y * NNParam Name.

apply-cli-configlet-job-results (vnd.net.juniper.space.configuration-management.apply-cli-configlet-job-results;version=1)

Collection of apply cli configlet job result detail

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this apply-cli-configlet-job-results node in the current node context. This link can be used to retrieve or operate on the currently referenced apply-cli-configlet-job-results in the tree path.
@totalIntegerYY N Total number of apply-cli-configlet-job-results in the API result set. If paging parameters are used in the query to limit the result set size, then total represents the total number of apply-cli-configlet-job-results in all the pages of the result set.
apply-cli-configlet-job-resultapply-cli-configlet-job-results.applyCLIConfigletJobResult[]NY Y * Apply cli configlet job result detail.

apply-cli-configlet-job-results.applyCLIConfigletJobResult

Apply cli configlet job result detail

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)YY N NNLink to this applyCLIConfigletJobResult node in the current node context. This link can be used to retrieve or operate on the currently referenced applyCLIConfigletJobResult in the tree path.

Hyperlink Template: /api/space/configuration-management/apply-cli-configlet-job-results/{*ID}.
idIntegerYY N NNJob result table row ID.
job-statusenum(job-status)YY N YYStatus of this job - same as status on the job.

Possible Values:
FAILEDFailed
SUCCESSSuccess
INPROGRESSInprogress
NOTSTARTEDScheduled
NOOPERATIONNo-Operation
CREATEDCreated
APPROVEDApproved
REJECTEDRejected
.
applied-configurationStringYY N NNConfiguration applied on the device.
cli-template-nameStringYY N YYCli Template Name.
paramsapply-cli-configlet-job-results.applyCLIConfigletJobResult.paramsDetailsMOsYY N NNCollection of Configlet Parameters.
post-configurationBooleanYY N NNPost Configuration.

Default: false.
categoryStringYY N NNCategory.
device-nameStringYY N YYDevice Name.
cli-template-idIntegerYY N YYCli Template ID.
descriptionStringYY N NNDescription.
job-remarksStringYY N YYJob Remarks.
contextStringYY N NNXPath to device configuration context.
post-parametersBooleanYY N NNPost Parameters.

Default: false.
job-percentage-completedDoubleYY N NNJob Percentage Completed.
job-idIntegerYY N NNJob ID.
device-idIntegerYY N NNDevice ID.
deviceStringYY N NNDevice Link

Hyperlink Template: /api/space/device-management/devices/{*ID}.
jobStringYY N NNJob Link

Hyperlink Template: /api/space/job-management/jobs/{*ID}.

apply-cli-configlet-job-results.applyCLIConfigletJobResult.paramsDetailsMOs

Collection of Configlet Parameters

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this paramsDetailsMOs node in the current node context. This link can be used to retrieve or operate on the currently referenced paramsDetailsMOs in the tree path.
@totalIntegerYY N Total number of gen_apply-cli-configlet-job-results-apply-cli-configlet-job-results-params-details-mos in the API result set. If paging parameters are used in the query to limit the result set size, then total represents the total number of gen_apply-cli-configlet-job-results-apply-cli-configlet-job-results-params-details-mos in all the pages of the result set.
paramapply-cli-configlet-job-results.applyCLIConfigletJobResult.paramsDetailsMOs.appliedParamsDetails[]NY Y * Configlet Parameter.

apply-cli-configlet-job-results.applyCLIConfigletJobResult.paramsDetailsMOs.appliedParamsDetails

Configlet Parameter

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)YY N NNLink to this appliedParamsDetails node in the current node context. This link can be used to retrieve or operate on the currently referenced appliedParamsDetails in the tree path.
param-valueStringNY Y * NNParam Value.
param-nameStringNY Y * NNParam Name.

apply-cli-configlet-request (vnd.net.juniper.space.configuration-management.apply-cli-configlet-request;version=3)

Apply configlet request configuration

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this apply-cli-configlet-request node in the current node context. This link can be used to retrieve or operate on the currently referenced apply-cli-configlet-request in the tree path.
deviceapply-cli-configlet-request.deviceNY Y * Device details.
contextStringNY Y The XPATH context.
cli-configlet-paramsapply-cli-configlet-request.cliConfigletParamsNY Y List of Configlet Parameters.

apply-cli-configlet-request.device

Device details

Field NameTypeRead OnlyGETPUT / POSTDescription
@hrefString(URI)NY Y * Link to an external device. Here, href points to the device in the primary device collection.

Hyperlink Template: /api/space/device-management/devices/{*ID}.
idIntegerYY N Device ID
Unique ID of the device through this device can be fetched.
nameStringYY N Device Name.

apply-cli-configlet-request.cliConfigletParams

List of Configlet Parameters

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this cliConfigletParams node in the current node context. This link can be used to retrieve or operate on the currently referenced cliConfigletParams in the tree path.
cli-configlet-paramapply-cli-configlet-request.cliConfigletParams.configletParamForNBI[]NY 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.

apply-cli-configlet-request.cliConfigletParams.configletParamForNBI

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 NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)YY N NNLink to this configletParamForNBI node in the current node context. This link can be used to retrieve or operate on the currently referenced configletParamForNBI in the tree path.
parameterapply-cli-configlet-request.cliConfigletParams.configletParamForNBI.paramForNBINY Y * NNParameter
Details of the parameter.
parameter-valueStringNY Y * NNParameter Value
Value of the parameter to be applied in configlet configuration.

apply-cli-configlet-request.cliConfigletParams.configletParamForNBI.paramForNBI

Parameter
Details of the parameter

Field NameTypeRead OnlyGETPUT / POSTDescription
@hrefString(URI)NY Y * Link to an external paramForNBI. Here, href points to the paramForNBI in the primary paramForNBI collection.

Hyperlink Template: /api/space/configuration-management/cli-configlets/{*ID}/cli-configlet-params/{*ID}.
param-idIntegerYY N Configlet Parameter ID
Unique key of the configlet parameter ID.

Default: 0.
nameStringYY N Parameter Name
Name of the parameter.
configlet-idIntegerYY N Configlet ID
Unique ID for the configlet.

archive-purge-audit-logs-by-age-request (vnd.net.juniper.space.audit-log-management.archive-purge-audit-logs-by-age-request;version=1)

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this archive-purge-audit-logs-by-age-request node in the current node context. This link can be used to retrieve or operate on the currently referenced archive-purge-audit-logs-by-age-request in the tree path.
purge-daysLongNY Y The number of days which is used as the criteria to select audit logs for purge operation. All the audit logs which are older than the given number of days will be purged.

Default: 90.
purge-from-all-domainsBooleanNY 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. If the value is "false" then the audit logs generated from the current domain alone will be purged.
The default value is "false".

Default: false.
archive-before-purgeBooleanNY Y The boolean value indicating whether the audit logs has to be archived before purge. If "true" the audit logs will be archived before purge else audit logs will be purged without archiving.
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-infoarchive-purge-audit-logs-by-age-request.auditlogArchiveNY Y The Information about the remote SCP server where the archived audit logs will be stored. If "archive-before-purge" is "true" and this information is not provided then the archived audit logs will be stored in Junos space server in the path "/var/lib/mysql/archive".

archive-purge-audit-logs-by-age-request.auditlogArchive

The Information about the remote SCP server where the archived audit logs will be stored. If "archive-before-purge" is "true" and this information is not provided then the archived audit logs will be stored in Junos space server in the path "/var/lib/mysql/archive"

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this auditlogArchive node in the current node context. This link can be used to retrieve or operate on the currently referenced auditlogArchive in the tree path.
user-nameStringNY 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.
passwordStringNY 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-ipStringNY Y * The IP of the remote SCP server in which the Junos space server will store the archive file.
archive-pathStringNY Y * The path in the remote SCP server where the Junos space server will store the archive file. The path provided is relative to the SCP server root directory.

archive-purge-audit-logs-by-time-request (vnd.net.juniper.space.audit-log-management.archive-purge-audit-logs-by-time-request;version=1)

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this archive-purge-audit-logs-by-time-request node in the current node context. This link can be used to retrieve or operate on the currently referenced archive-purge-audit-logs-by-time-request in the tree path.
purge-timeLongNY Y * The time which is used as the criteria to select audit logs for purge operation. All the audit logs generated before this time will be purged. (The input should be the number of milliseconds since January 1, 1970, 00:00:00 UTC ).
purge-from-all-domainsBooleanNY 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. If the value is "false" then the audit logs generated from the current domain alone will be purged.
The default value is "false".

Default: false.
archive-before-purgeBooleanNY Y The boolean value indicating whether the audit logs has to be archived before purge. If "true" the audit logs will be archived before purge else audit logs will be purged without archiving.
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-infoarchive-purge-audit-logs-by-time-request.auditlogArchiveNY Y The Information about the remote SCP server where the archived audit logs will be stored. If "archive-before-purge" is "true" and this information is not provided then the archived audit logs will be stored in Junos space server in the path "/var/lib/mysql/archive".

archive-purge-audit-logs-by-time-request.auditlogArchive

The Information about the remote SCP server where the archived audit logs will be stored. If "archive-before-purge" is "true" and this information is not provided then the archived audit logs will be stored in Junos space server in the path "/var/lib/mysql/archive"

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this auditlogArchive node in the current node context. This link can be used to retrieve or operate on the currently referenced auditlogArchive in the tree path.
user-nameStringNY 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.
passwordStringNY 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-ipStringNY Y * The IP of the remote SCP server in which the Junos space server will store the archive file.
archive-pathStringNY Y * The path in the remote SCP server where the Junos space server will store the archive file. The path provided is relative to the SCP server root directory.

archive-purge-jobs-local-request (vnd.net.juniper.space.job-management.archive-purge-jobs-local-request;version=3)

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this archive-purge-jobs-local-request node in the current node context. This link can be used to retrieve or operate on the currently referenced archive-purge-jobs-local-request in the tree path.
purge-from-all-domainsBooleanNY Y * Purge From All Domains.
archive-jobs-beforeLongNY Y * Job which triggered before this date will be archived.Value should be in UTC long value.
job-typeStringNY Y * Type of job to be purge List of types are available under /api/space/job-management/job-types.

Default: "All".

archive-purge-jobs-remote-request (vnd.net.juniper.space.job-management.archive-purge-jobs-remote-request;version=3)

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this archive-purge-jobs-remote-request node in the current node context. This link can be used to retrieve or operate on the currently referenced archive-purge-jobs-remote-request in the tree path.
archive-jobs-beforeLongNY Y * Job which triggered before this date will be archived.Value should be in UTC long value.
job-typeStringNY Y * Type of job to be purge List of types are available under /api/space/job-management/job-types.

Default: "All".
purge-from-all-domainsBooleanNY Y * Purge From All Domains.
userStringNY Y * user name of remote machine to remote authentication.
passwordStringNY Y * Password for the above mentioned user to remote authentication.
ipStringNY Y * ip of the machine in which the archive files will be stored.
pathStringNY Y * file path to save archive files Note: This should end with /.

assign-devices (vnd.net.juniper.space.domain-management.assign-devices;version=3)

Field NameTypeRead OnlyGETPUT / POSTDescription
devicesassign-devices.devicesNY Y *  

assign-devices.devices

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this devices node in the current node context. This link can be used to retrieve or operate on the currently referenced devices in the tree path.
deviceassign-devices.devices.device[]NY Y *  

assign-devices.devices.device

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@hrefString(URI)NY Y * NNLink to an external device. Here, href points to the device in the primary device collection.

Hyperlink Template: /api/space/device-management/devices/{*ID}.
idIntegerYY N YYDevice ID.
nameStringYY N YYDevice Name.

assign-devices-job-results (vnd.net.juniper.space.domain-management.assign-devices-job-results;version=3)

Get Assign devices to domain job results for the specified Job Id

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this assign-devices-job-results node in the current node context. This link can be used to retrieve or operate on the currently referenced assign-devices-job-results in the tree path.
@totalIntegerYY N Total number of assign-devices-job-results in the API result set. If paging parameters are used in the query to limit the result set size, then total represents the total number of assign-devices-job-results in all the pages of the result set.
assign-devices-job-resultassign-devices-job-results.assignDevicesResult[]NY Y *  

assign-devices-job-results.assignDevicesResult

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)YY N NNLink to this assignDevicesResult node in the current node context. This link can be used to retrieve or operate on the currently referenced assignDevicesResult in the tree path.
idIntegerYY N NNJob result table row ID.
assign-device-statusenum(assign-device-status)NY Y * YYDevice assignment to domain status(Can be any one of FAILURE, SUCCESS or INPROGRESS).

Possible Values:
FAILEDFailed
SUCCESSSuccess
INPROGRESSInprogress
.
hostnameStringNY Y * YYHostname of the device.
assign-descriptionStringNY Y * YNFailure reason for the device assignment failure.
device-idIntegerNY Y * YYdevice id.
ipStringNY Y * YNIP address of the device.

associated-devices (vnd.net.juniper.space.software-management.associated-devices;version=2)

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this associated-devices node in the current node context. This link can be used to retrieve or operate on the currently referenced associated-devices in the tree path.
@totalIntegerYY N Total number of associated-devices in the API result set. If paging parameters are used in the query to limit the result set size, then total represents the total number of associated-devices in all the pages of the result set.
deviceassociated-devices.deviceImageValidation[]NY Y *  

associated-devices.deviceImageValidation

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)YY N NNLink to this deviceImageValidation node in the current node context. This link can be used to retrieve or operate on the currently referenced deviceImageValidation in the tree path.

Hyperlink Template: /api/space/software-management/packages/{*ID}/associated-devices.
@hrefString(URI)NY Y * NNLink to an external deviceImageValidation. Here, href points to the deviceImageValidation in the primary deviceImageValidation collection.

Hyperlink Template: /api/space/device-management/devices/{*ID}.
checksum-statusenum(checksum-status)NY Y NN

Possible Values:
VALIDValid
INVALIDInvalid
.
checksum-timeStringNY Y NN 
ip-addrStringNY Y NN 
device-nameStringNY Y NN 
device-idIntegerNY Y NN 

associated-devices (vnd.net.juniper.space.software-management.associated-devices;version=3)

Devices associated with the Software Package

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this associated-devices node in the current node context. This link can be used to retrieve or operate on the currently referenced associated-devices in the tree path.
@totalIntegerYY N Total number of associated-devices in the API result set. If paging parameters are used in the query to limit the result set size, then total represents the total number of associated-devices in all the pages of the result set.
associated-deviceassociated-devices.deviceImageAssociation[]NY Y * A collection of Devices associated with the Software Package.

associated-devices.deviceImageAssociation

A collection of Devices associated with the Software Package.

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@hrefString(URI)NY Y * NNLink to an external deviceImageAssociation. Here, href points to the deviceImageAssociation in the primary deviceImageAssociation collection.

Hyperlink Template: /api/space/device-management/devices/{*ID}.
@uriString(URI)YY N NNLink to this deviceImageAssociation node in the current node context. This link can be used to retrieve or operate on the currently referenced deviceImageAssociation in the tree path.

Hyperlink Template: /api/space/software-management/packages/{*ID}/associated-devices/{*ID}.
checksum-statusenum(checksum-status)YY N YYStates whether or not the Software Package staged on the Device is Valid.

Possible Values:
VALIDValid
INVALIDInvalid
.
device-nameStringYY N NNName of the Device associated with the Software Package.
deployed-statusenum(deployed-status)YY N NNStates whether or not the Software Package is Deployed on the Device.

Possible Values:
DEPLOYEDDeployed
NOTDEPLOYEDNot Deployed
.
checksum-timeDateYY N YYTime at which the Software Package staged on the Device is validated.
staged-statusenum(staged-status)YY N YYStates whether or not the Software Package is Staged on the Device.

Possible Values:
NOTSTAGEDNot Staged
STAGEDStaged

Default: NOTSTAGED.
device-idIntegerYY N NNID of the Device associated with the Software Package.
ip-addressStringYY N NNIP Address of the Device associated with the Software Package.

associated-scripts (vnd.net.juniper.space.device-management.associated-scripts;version=1)

This resource model represents a user's view of all accessible resources in the space. A ScriptDeviceAssociationMOs type in 'ScriptDeviceAssociationMOs' represents pull-through data. The "ScriptDeviceAssociationMOs" is a complex type and consists of the following pull-through fields:

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)NY Y Link to this associated-scripts node in the current node context. This link can be used to retrieve or operate on the currently referenced associated-scripts in the tree path.
@sizeIntegerNY Y Total number of results available
script-device-associationassociated-scripts.scriptDeviceAssociationMO[]NY Y * The collection of associations. Each object in the collection represents an association between a script and a device.

associated-scripts.scriptDeviceAssociationMO

The 'scriptDeviceAssociationMO' type represents association details about scripts and devices. It consists of the following fields:

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
scriptassociated-scripts.scriptDeviceAssociationMO.scriptNY Y * NNThe script metadata (that is, script ID, name, and type).
script-categoryStringNY Y * YY Category of the script. It would be an arbitrary value used for sorting/filtering
deployed-versionStringNY Y * NN The script deployed version
device-nameStringNY Y * NN The name of the device
script-statusenum(script-status)NY Y * NN The script status

Possible Values:
ENABLEDEnabled
DISABLEDDisabled
NOTAVAILNA

associated-scripts.scriptDeviceAssociationMO.script

Field NameTypeRead OnlyGETPUT / POSTDescription
@hrefString(URI)NY Y Link to an external script. Here, href points to the script in the primary script collection.
@uriString(URI)NY Y Link to this script node in the current node context. This link can be used to retrieve or operate on the currently referenced script in the tree path.
script-idLongNY Y * The script's ID.
script-nameStringNY Y * The name of the script
script-typeStringNY Y * The script status, which is either enabled or disabled.

associated-softwares (vnd.net.juniper.space.device-management.associated-softwares;version=7)

Software Packages associated with the Device

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this associated-softwares node in the current node context. This link can be used to retrieve or operate on the currently referenced associated-softwares in the tree path.
@totalIntegerYY N Total number of associated-softwares in the API result set. If paging parameters are used in the query to limit the result set size, then total represents the total number of associated-softwares in all the pages of the result set.
associated-softwareassociated-softwares.deviceImageValidation[]NY Y * A collection of Software Packages associated with the Device.

associated-softwares.deviceImageValidation

A collection of Software Packages associated with the Device

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)YY N NNLink to this deviceImageValidation node in the current node context. This link can be used to retrieve or operate on the currently referenced deviceImageValidation in the tree path.

Hyperlink Template: /api/space/software-management/packages/{*ID}.
@hrefString(URI)NY Y * NNLink to an external deviceImageValidation. Here, href points to the deviceImageValidation in the primary deviceImageValidation collection.

Hyperlink Template: /api/space/software-management/packages/{*ID}.
checksum-statusenum(checksum-status)NY Y NNStates whether or not the Software Package staged on the Device is Valid.

Possible Values:
VALIDValid
INVALIDInvalid
.
checksum-timeStringNY Y NNTime at which the Software Package staged on the Device is validated.
software-file-nameStringNY Y NNName of the Software Package associated with the Device.
software-idIntegerYY N NNID of the Software Package associated with the Device.

audit-log (vnd.net.juniper.space.application-management.platform.settings.audit-log;version=1)

The 'audit-log' resource model represents details of "RecordGet" settings on Junos Space. It consists of the following fields:

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)NY Y Link to this audit-log node in the current node context. This link can be used to retrieve or operate on the currently referenced audit-log in the tree path.
record-http-get-methodBooleanNY Y * Indicates whether a record is returned.
auditlog-forwarding-intervalIntegerNY Y * Audit log forwarding interval in minutes.
log-success-scenarioBooleanNY Y * Indicates whether a Log Successful Audit Log forwarding.

audit-log (vnd.net.juniper.space.audit-log-management.audit-log;version=1)

This represents a single audit log record.

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)NY Y Link to this audit-log node in the current node context. This link can be used to retrieve or operate on the currently referenced audit-log in the tree path.
userNameStringNY Y Contains the name of the user who accessed the API.
userIpAddrStringNY Y Contains the IP of the user who accessed the API.
descriptionStringNY Y Contains the description of what the API did.
logTimeStringNY Y Contains the current server timestamp.
applicationNameStringNY Y Contains the constant 'REST' to represent that the record was logged by the REST API.
taskNameStringNY Y Contains the URI of the API.
resultStringNY Y Contains the HTTP status code returned to the user.
domainIdIntegerNY Y Contains the domain id of the audit log object.
domainNameStringNY Y Contains the domain name of the audit log object
jobaudit-log.jobNY Y Contains the job information related to the API, if the API is asynchronous.
objectaudit-log.modifiedObject[]NY Y Contains the modified object's information related to the API, if the API is synchronous.
workSpaceNameStringNY Y  
domainStringYY N  

audit-log.job

This contains the job information related to API, if API is asynchronous.

Field NameTypeRead OnlyGETPUT / POSTDescription
@hrefString(URI)NY Y Link to an external job. Here, href points to the job in the primary job collection.
idIntegerNY Y Job ID.

audit-log.modifiedObject

This contains the mopdified objects information related to API, if API is synchronous.

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
linkaudit-log.modifiedObject.modifiedObjectLinkNY Y NNReference to modified object.
object-nameStringNY Y NN Field contains the name of modified object.
object-detailStringNY Y NNModified Object Detail.

audit-log.modifiedObject.modifiedObjectLink

This contains the mopdified objects information related to API, if API is synchronous.

audit-logs (vnd.net.juniper.space.audit-log-management.audit-logs;version=1)

This represents the collection of audit log records logged.

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)NY Y Link to this audit-logs node in the current node context. This link can be used to retrieve or operate on the currently referenced audit-logs in the tree path.
@sizeIntegerNY Y Contains the size of the collection of records.
@totalIntegerNY Y Total number of audit-logs in the API result set. If paging parameters are used in the query to limit the result set size, then total represents the total number of audit-logs in all the pages of the result set.
audit-logaudit-logs.auditlogTO[]NY Y Contains the record entries.

audit-logs.auditlogTO

Contains information of a particular record.

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)NY Y NNLink to this auditlogTO node in the current node context. This link can be used to retrieve or operate on the currently referenced auditlogTO in the tree path.
@hrefString(URI)NY Y NNLink to an external auditlogTO. Here, href points to the auditlogTO in the primary auditlogTO collection.
@keyIntegerNY Y NN Contains the ID of the record.
userNameStringNY Y NN Contains the name of the user who accessed the API.
userIpAddrStringNY Y NN Contains the IP of the user who accessed the API.
descriptionStringNY Y NN Contains the description of what the API did.
logTimeStringNY Y NN Contains the current server timestamp.
workSpaceNameStringNY Y NN Contains the workspace related information.
applicationNameStringNY Y NN Contains the constant 'REST' to represent that the record was logged by the REST API.
taskNameStringNY Y YY Contains the URI of the API.
resultStringNY Y NN Contains the HTTP status code returned to the user.
jobIdintNY Y * YY Contains the job id information.
domainIdintNY Y * NY 
domainNameStringNY Y NN 

audit-template-config-version-request (vnd.net.juniper.space.config-template-management.audit-template-config-version-request;version=2)

Field NameTypeRead OnlyGETPUT / POSTDescription
device-idsaudit-template-config-version-request.deviceIDsNY Y *  

audit-template-config-version-request.deviceIDs

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this deviceIDs node in the current node context. This link can be used to retrieve or operate on the currently referenced deviceIDs in the tree path.
device-idInteger[]NY Y * Device IDs.

authmode (vnd.net.juniper.space.application-management.platform.settings.authmode;version=1)

The 'user' resource model represents details of "AuthMode" settings on Junos Space. It consists of following fields:

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)NY Y Link to this authmode node in the current node context. This link can be used to retrieve or operate on the currently referenced authmode in the tree path.
auth-modeStringNY Y * Authentication Mode.

cancel-jobs-request (vnd.net.juniper.space.job-management.cancel-jobs-request;version=3)

Field NameTypeRead OnlyGETPUT / POSTDescription
jobscancel-jobs-request.instanceManagedObjectsNY Y *  

cancel-jobs-request.instanceManagedObjects

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this instanceManagedObjects node in the current node context. This link can be used to retrieve or operate on the currently referenced instanceManagedObjects in the tree path.
jobcancel-jobs-request.instanceManagedObjects.monitorableTaskInstanceManagedObject[]NY Y *  

cancel-jobs-request.instanceManagedObjects.monitorableTaskInstanceManagedObject

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@hrefString(URI)NY Y * NNLink to an external monitorableTaskInstanceManagedObject. Here, href points to the monitorableTaskInstanceManagedObject in the primary monitorableTaskInstanceManagedObject collection.

Hyperlink Template: /api/space/job-management/jobs/{*ID}.
idIntegerYY N YYThe ID of the job.
nameStringYY N NNMonitorableTaskInstanceManagedObject Name.

capabilities (vnd.net.juniper.space.user-management.capabilities;version=3)

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this capabilities node in the current node context. This link can be used to retrieve or operate on the currently referenced capabilities in the tree path.
@totalIntegerYY N Total number of capabilities in the API result set. If paging parameters are used in the query to limit the result set size, then total represents the total number of capabilities in all the pages of the result set.
capabilitycapabilities.capability[]NY Y *  

capabilities.capability

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@hrefString(URI)NY Y * NNLink to an external capability. Here, href points to the capability in the primary capability collection.

Hyperlink Template: /api/space/user-management/capabilities/{*ID}.
idIntegerYY N NNID.
nameStringYY N NNName.
titleStringYY N NNTitle.

capabilities (vnd.net.juniper.space.user-management.capabilities;version=1)

The 'capabilities' resource model represents a view of all the capabilities present in the system. The 'capability' field in 'capabilities' represent pull-through data. It consists of the following fields:

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)NY Y * Link to this capabilities node in the current node context. This link can be used to retrieve or operate on the currently referenced capabilities in the tree path.
@sizeIntegerNY Y * The total number of capabilities available in the System.
capabilitycapabilities.capability[]NY Y * The collection of objects of type 'capability'. Each object represents a capability present in the system.

capabilities.capability

The 'capability' field of type 'capability' consists of the following pull-through fields:

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
keyIntegerNY Y NN A unique identifier for the capability.
nameStringNY Y YY The name of the capability.
uriStringNY Y NN A link to identify the 'capability' resource.
hrefStringNY Y NN The location of the 'capability' resource.

capabilities-ref (vnd.net.juniper.space.user-management.capabilities-ref;version=1)

The 'capabilities-ref' resource model represents all the capabilities associated with a role. The 'capability' field in 'capabilities' represents pull-through data. It consists of the following fields:

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)NY Y * Link to this capabilities-ref node in the current node context. This link can be used to retrieve or operate on the currently referenced capabilities-ref in the tree path.
@sizeIntegerNY Y The total number of capabilities associated with a role.
capabilitycapabilities-ref.capability[]NY Y The collection of objects of type 'capability'. Each object represents a capability associated with the role.

capabilities-ref.capability

The 'capability' field of type 'capability' consists of the following pull-through fields:

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
keyIntegerNY Y NN The unique identifier for a capability.
nameStringNY Y NN The name of the capability.
hrefStringNY Y NN The location of a capability.
uriStringNY Y NN A link to identify the 'capability' resource.

capability (vnd.net.juniper.space.user-management.capability;version=1)

The 'capability' resource model represents details about a capability present in the system. It also displays the roles and tasks associated with a capability. It consists of the following fields:

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)NY Y * Link to this capability node in the current node context. This link can be used to retrieve or operate on the currently referenced capability in the tree path.
idIntegerNY Y * A unique identifier for the capability.
nameStringNY Y * The name of the capability.
titleStringNY Y The title of the capability.
taskscapability.tasksNY Y The tasks associated with the capability.
rolescapability.rolesNY Y The roles associated with the capability.

capability.tasks

The 'tasks' field of type 'tasks' represents information about the tasks associated with the capability. It consists of the following fields:

Field NameTypeRead OnlyGETPUT / POSTDescription
taskcapability.tasks.capabilityTask[]NY Y The collection of objects of type 'capabilityTask'. Each object represents a task associated with the capability.
uriStringNY Y A link to identify the tasks associated with a capability.

capability.tasks.capabilityTask

The 'tasks' field of type 'capabilityTask' consists of the following pull-through fields:

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
idIntegerNY Y NN The unique identifier for a task.
nameStringNY Y NN The name of the task.
hrefStringNY Y NN The location of a task.
uriStringNY Y NN A link to identify the task associated with the capability.

capability.roles

The 'roles' field of type 'roles' represents information about the roles associated with the capability. It consists of the following fields:

Field NameTypeRead OnlyGETPUT / POSTDescription
rolecapability.roles.capabilityRole[]NY Y The collection of objects of type 'capabilityRole'. Each object represents a role associated with the capability.
uriStringNY Y A link to identify the roles associated with the capability.

capability.roles.capabilityRole

The 'roles' field of type 'capabilityRole' consists of the following pull-through fields:

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
idIntegerNY Y NN The unique identifier for a role.
nameStringNY Y NN The name of the role.
hrefStringNY Y NN The location of a role.
uriStringNY Y NN A link to identify the role associated with the capability.

capability-ref (vnd.net.juniper.space.user-management.capability-ref;version=3)

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this capability-ref node in the current node context. This link can be used to retrieve or operate on the currently referenced capability-ref in the tree path.

Hyperlink Template: /api/space/user-management/roles/{*ID}/capabilities/{*ID}.
@hrefString(URI)NY Y * Link to an external capability-ref. Here, href points to the capability-ref in the primary capability-ref collection.

Hyperlink Template: /api/space/user-management/capabilities/{*ID}.
idIntegerYY N Capability ID.
nameStringYY N Capability Name.

capability-ref (vnd.net.juniper.space.user-management.capability-ref;version=1)

The 'capability-ref' resource model represents details about a capability associated with a role. It consists of the following fields:

Field NameTypeRead OnlyGETPUT / POSTDescription
@keyIntegerNY Y * A unique identifier for the capability.
@hrefString(URI)NY Y * Link to an external capability-ref. Here, href points to the capability-ref in the primary capability-ref collection.
@uriString(URI)NY Y * Link to this capability-ref node in the current node context. This link can be used to retrieve or operate on the currently referenced capability-ref in the tree path.
nameStringNY Y * The name of the capability.
titleStringNY Y The title of the capability.

capability-refs (vnd.net.juniper.space.user-management.capability-refs;version=3)

Field NameTypeRead OnlyGETPUT / POSTPATCHDescription
@uriString(URI)YY N NLink to this capability-refs node in the current node context. This link can be used to retrieve or operate on the currently referenced capability-refs in the tree path.
@totalIntegerYY N NTotal number of capabilities in the API result set. If paging parameters are used in the query to limit the result set size, then total represents the total number of capabilities in all the pages of the result set.
capabilitycapability-refs.capability[]NY Y * Y 

capability-refs.capability

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)YY N NNLink to this capability node in the current node context. This link can be used to retrieve or operate on the currently referenced capability in the tree path.

Hyperlink Template: /api/space/user-management/roles/{*ID}/capabilities/{*ID}.
@hrefString(URI)NY Y * NNLink to an external capability. Here, href points to the capability in the primary capability collection.

Hyperlink Template: /api/space/user-management/capabilities/{*ID}.
idIntegerYY N NNCapability ID.
nameStringYY N NNCapability Name.

Capability-refs_patch (vnd.net.juniper.space.user-management.capability-refs_patch;version=3)

catalog-configuration-response (vnd.net.juniper.space.hardware-catalog.catalog-configuration-response;version=1)

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this catalog-configuration-response node in the current node context. This link can be used to retrieve or operate on the currently referenced catalog-configuration-response in the tree path.
current-hw-revisionStringNY Y * Current HW Revision.

Default: "N/A".
current-hw-publishedStringNY Y * Current HW Published.

Default: "N/A".
current-hw-last-updateStringNY Y * Current HW Last Update.

Default: "N/A".
svn-hw-revisionStringNY Y * Svn HW Revision.
svn-hw-publishedStringNY Y * Svn HW Published.

categories (vnd.net.juniper.space.debuglog-management.categories;version=1)

The 'categories' resource model represents a user's view of all accessible logging categories in the system. It consists of the following pull-through fields:

Field NameTypeRead OnlyGETPUT / POSTDescription
@sizeIntegerNY Y Total number of categories.
@uriString(URI)NY Y Link to this categories node in the current node context. This link can be used to retrieve or operate on the currently referenced categories in the tree path.
categorycategories.category[]NY Y A collection of categories. Each object represents details about the respective category.

categories.category

The 'category' field of type 'category' represents a logging category. It consists of the following pull-through fields:

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@hrefString(URI)NY Y NNLink to an external category. Here, href points to the category in the primary category collection.
@uriString(URI)NY Y NNLink to this category node in the current node context. This link can be used to retrieve or operate on the currently referenced category in the tree path.
@keyStringNY Y NN Unique identifier for the category.
packageNameStringNY Y YN Name of package for the logging configuration.
priorityenum(priority)NY Y YN Priority level for the logging configuration.

Possible Values:
ALL 
TRACE 
DEBUG 
INFO 
WARN 
ERROR 
FATAL 
OFF 
handlerStringNY Y NNlog file handler name.

categories.category.priority

category (vnd.net.juniper.space.debuglog-management.category;version=1)

The 'category' resource model represents a user's view of a particular category present in the system. It consists of the following fields:

Field NameTypeRead OnlyGETPUT / POSTDescription
packageNameStringNY Y * Name of package for the logging configuration.
priorityenum(priority)NY Y Priority level for the logging configuration.

Possible Values:
ALL 
TRACE 
DEBUG 
INFO 
WARN 
ERROR 
FATAL 
OFF 
handlerStringNY Y log file handler name.

category.priority

certificate (vnd.net.juniper.space.user-management.certificate;version=3)

This API to get certificate for the user

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this certificate node in the current node context. This link can be used to retrieve or operate on the currently referenced certificate in the tree path.

Hyperlink Template: /api/space/user-management/certificate.
sig-alg-nameStringYY N Sig Alg Name.
domain-idIntegerYY N Domain ID.
not-afterStringYY N Not After.
domain-nameStringYY N Domain Name.
cert-datacertificate.certDatasNY Y *  
serial-numberStringYY N Serial Number.
cert-typeStringYY N cert type could be PERSONAL or CA.
last-updateLongYY N Last Update.
not-beforeStringYY N Not Before.
expire-timeLongYY N Expire Time.
*idIntegerYY N X509Cert ID.
nameStringYY N X509Cert Name.
crl-serialsStringYY N Crl Serials.
issuer-nameStringYY N Issuer Name.
raw-file-nameStringYY N Raw File Name.

certificate.certDatas

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this certDatas node in the current node context. This link can be used to retrieve or operate on the currently referenced certDatas in the tree path.
cert-dataByte[]NY Y * Cert Datas.

change-credentials-request (vnd.net.juniper.space.device-management.change-credentials-request;version=4)

The 'change-credentials' resource model represents a a view of information about the change-credentials for a group of devices. It consists of the the following fields:

Field NameTypeRead OnlyGETPUT / POSTDescription
deviceschange-credentials-request.devicesNY Y * A collection of devices. Each object in the collection refers to a device.
user-nameStringNY Y * Credential user name.
passwordStringNY Y Credential password.
change-toenum(change-to)NY Y * Authentication Type. Possible Values: KEY, CREDENTIAL.

Possible Values:
KEY 
CREDENTIAL 
change-on-deviceBooleanNY Y Change credentials on devices.

change-credentials-request.credentialsType


change-credentials-request.devices

The 'devices' field of type 'devices' represents a collection of devices. It consists of the the following fields:

Field NameTypeRead OnlyGETPUT / POSTDescription
devicechange-credentials-request.device[]NY Y * A collection of devices. Each object in the collection represents details of a device.

change-credentials-request.device

The 'device' field of type 'device' represents the information of a device. It consists of the the following fields:

Field NameTypeRead OnlyGETPUT / POSTDescription
@hrefString(URI)NY Y * Link to an external device. Here, href points to the device in the primary device collection.
idIntegerNY Y Unique identifier for the 'device'.
nameStringNY Y Name of the device

change-credentials-request (vnd.net.juniper.space.device-management.change-credentials-request;version=4)

The 'change-credentials' resource model represents a a view of information about the change-credentials for a group of devices. It consists of the the following fields:

Field NameTypeRead OnlyGETPUT / POSTDescription
deviceschange-credentials-request.devicesNY Y * A collection of devices. Each object in the collection refers to a device.
user-nameStringNY Y * Credential user name.
passwordStringNY Y Credential password.
change-toenum(change-to)NY Y Authentication Type. Possible Values: KEY, CREDENTIAL.

Possible Values:
KEY 
CREDENTIAL 
change-on-deviceBooleanNY Y Change credentials on devices. Note: change-on-device must always be true for KEY/CREDENTIAL to KEY based changes.
re-authenticate-deviceBooleanNY Y Flag for Re-authenticate the connection to device.

change-credentials-request.credentialsType


change-credentials-request.devices

The 'devices' field of type 'devices' represents a collection of devices. It consists of the the following fields:

Field NameTypeRead OnlyGETPUT / POSTDescription
devicechange-credentials-request.device[]NY Y A collection of devices. Each object in the collection represents details of a device.

change-credentials-request.device

The 'device' field of type 'device' represents the information of a device. It consists of the the following fields:

Field NameTypeRead OnlyGETPUT / POSTDescription
@hrefString(URI)NY Y * Link to an external device. Here, href points to the device in the primary device collection.
idIntegerNY Y * Unique identifier for the 'device'.
nameStringNY Y Name of the device

change-password (vnd.net.juniper.space.user-management.change-password;version=1)

The 'change-password' resource model represents a password change for a user. It consists of the following fields:

Field NameTypeRead OnlyGETPUT / POSTDescription
oldPasswordStringNY Y * The user's old password
newPasswordStringNY Y * The user's new password

change-password-to-temp (vnd.net.juniper.space.user-management.change-password-to-temp;version=3)

Field NameTypeRead OnlyGETPUT / POSTDescription
old-passwordStringNY Y * Old Password.
password-expiry-timeDateNY Y * Password Expiry Time.
email-passwordBooleanNY Y * Email Password.

Default: false.

change-request (vnd.net.juniper.space.configuration-management.change-request;version=2)

The 'change-request' resource model represents details about a change request. It also displays detailed information about the device on which this change-request was posted. It consists of the following fields:

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)NY Y Link to this change-request node in the current node context. This link can be used to retrieve or operate on the currently referenced change-request in the tree path.
idIntegerNY Y * A unique identifier for the change request.
nameStringNY Y Name of the change request.
descriptionStringNY Y Description for the change request.
xmlDataStringNY Y The configuration data needed for the change request.
devicechange-request.deviceNY Y * The representation of the device.
syncAfterPushBooleanNY Y Whether to re-synchronize the device after the configuration update or not.
resultStringNY Y Result of the change request deployment to the device.

change-request.device

The 'device' field of 'device' type provides detailed information about the device on which the change request was created. It consists of the following fields:

Field NameTypeRead OnlyGETPUT / POSTDescription
@hrefString(URI)NY Y Link to an external device. Here, href points to the device in the primary device collection.
idLongNY Y Unique identifier for the device.

change-requests (vnd.net.juniper.space.configuration-management.change-requests;version=1)

The 'change-requests' resource model represents the user's view of all the change requests present in the system. The 'change-request' field in 'change-requests' represents pull-through data. It consists of the following fields:

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)NY Y * Link to this change-requests node in the current node context. This link can be used to retrieve or operate on the currently referenced change-requests in the tree path.
@sizeIntegerNY Y * Total number of change-requests available in the System.
@totalIntegerNY Y * Total number of change-requests in the API result set. If paging parameters are used in the query to limit the result set size, then total represents the total number of change-requests in all the pages of the result set.
change-requestchange-requests.changeRequestDO[]NY Y The collection of objects of type 'change-request'. Each object represents a change-request present in the system.

change-requests.changeRequestDO

The 'change-request' field of type 'change-request' consists of the following pull-through fields:

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@hrefString(URI)NY Y * NNLink to an external changeRequestDO. Here, href points to the changeRequestDO in the primary changeRequestDO collection.
@uriString(URI)NY Y * NNLink to this changeRequestDO node in the current node context. This link can be used to retrieve or operate on the currently referenced changeRequestDO in the tree path.
@keyIntegerNY Y * NN Unique identifier for the change-request.
deviceIdLongNY Y * NN The device identifier corresponding to the change request.
nameStringNY Y YY Name of the change request.
descriptionStringNY Y YY The description for the change request.

change-requests (vnd.net.juniper.space.configuration-management.change-requests;version=2)

The 'change-request' resource model represents details about a change request. It also displays detailed information about the device on which this change request was posted. It consists of the following fields:

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)NY Y Link to this change-requests node in the current node context. This link can be used to retrieve or operate on the currently referenced change-requests in the tree path.
change-requestchange-requests.changeRequestDO[]NY Y A single change request.

change-requests.changeRequestDO

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@hrefString(URI)NY Y NNLink to an external changeRequestDO. Here, href points to the changeRequestDO in the primary changeRequestDO collection.
idIntegerNY Y * NN A unique identifier for the change request.
nameStringNY Y NN Name of the change request.
descriptionStringNY Y YY Description for the change request.
xmlDataStringNY Y NN The configuration data needed for the change request.
devicechange-requests.changeRequestDO.deviceNY Y * NN The representation of the device.
syncAfterPushBooleanNY Y NN Whether to re-synchronize the device after the configuration update or not.
resultchange-requests.changeRequestDO.resultNY Y NNResult of change request deployment to the device.

change-requests.changeRequestDO.device

The 'device' field of 'device' type provides detailed information about the device on which the change request was created. It consists of the following fields:

Field NameTypeRead OnlyGETPUT / POSTDescription
@hrefString(URI)NY Y Link to an external device. Here, href points to the device in the primary device collection.
idLongNY Y Unique identifier for the device.

change-requests.changeRequestDO.result

Field NameTypeRead OnlyGETPUT / POSTDescription
statusStringNY Y Status of change request deployment.
messageStringNY Y Message (if any) from the device after a change request deployment.
rpc-replyStringNY Y Complete rpc-reply message.
changeReqIdIntegerNY Y Change request ID.
syncAfterPushBooleanNY Y Synchronize device configuration to Junos Space after a change request deployment.

change-requests (vnd.net.juniper.space.device-management.change-requests;version=1)

The 'change-requests' resource model represent a view of information about the change-requests for a device. It consists of the following fields:

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)NY Y * Link to this change-requests node in the current node context. This link can be used to retrieve or operate on the currently referenced change-requests in the tree path.
@sizeIntegerNY Y * Total number of change-requests available in the system.
@totalIntegerNY Y * Total number of change-requests in the API result set. If paging parameters are used in the query to limit the result set size, then total represents the total number of change-requests in all the pages of the result set.
change-requestchange-requests.changeRequest[]NY Y A collection of change requests. Each object in the collection represents details of a change-request.

change-requests.changeRequest

The 'change-request' field of type 'changeRequest' represents details of a change request. It consists of the following pull-through fields:

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@hrefString(URI)NY Y * NNLink to an external changeRequest. Here, href points to the changeRequest in the primary changeRequest collection.
@keyIntegerNY Y * NN Unique identifier for the 'change-request'.
deviceIdLongNY Y NN Unique identifier for the device on which the change-request was submitted.
nameStringNY Y YY Name of the change-request.
descriptionStringNY Y YY Description of change-request

children (vnd.net.juniper.space.domain-management.children;version=2)

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this children node in the current node context. This link can be used to retrieve or operate on the currently referenced children in the tree path.
@totalIntegerYY N Total number of domains in the API result set. If paging parameters are used in the query to limit the result set size, then total represents the total number of domains in all the pages of the result set.
domainchildren.domain[]NY Y *  

children.domain

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@hrefString(URI)YY N NNLink to an external domain. Here, href points to the domain in the primary domains collection.

Hyperlink Template: /api/space/domain-management/domains/{*ID}.
@uriString(URI)YY N NNLink to this domain node in the current node context. This link can be used to retrieve or operate on the currently referenced domain in the tree path.

Hyperlink Template: /api/space/domain-management/domains/{*ID}/children/{*ID}.
descriptionStringNY Y * NNDescription added by user.
idIntegerNY Y * NNID of domain.
nameStringNY Y * NNName of the domain.

clear-local-passwords-request (vnd.net.juniper.space.user-management.clear-local-passwords-request;version=3)

Field NameTypeRead OnlyGETPUT / POSTDescription
usersclear-local-passwords-request.usersNY Y *  

clear-local-passwords-request.users

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this users node in the current node context. This link can be used to retrieve or operate on the currently referenced users in the tree path.
userclear-local-passwords-request.users.user[]NY Y * Get all users.

clear-local-passwords-request.users.user

Get all users

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@hrefString(URI)NY Y * NNLink to an external user. Here, href points to the user in the primary users collection.

Hyperlink Template: /api/space/user-management/users/{*ID}.
idIntegerYY N YYUser ID.
nameStringYY N YYUser Name.

cli-configlet (vnd.net.juniper.space.configuration-management.cli-configlet;version=3)

Configlet details

Field NameTypeRead OnlyGETPUT / POSTPATCHDescription
@uriString(URI)YY N NLink to this cli-configlet node in the current node context. This link can be used to retrieve or operate on the currently referenced cli-configlet in the tree path.

Hyperlink Template: /api/space/configuration-management/cli-configlets/{*ID}.
@hrefString(URI)YY N NLink to an external cli-configlet. Here, href points to the cli-configlet in the primary cli-configlets collection.

Hyperlink Template: /api/space/configuration-management/cli-configlets/{*ID}.
*idIntegerYY N NConfiglet ID
This is the unique key value used to access/identify the specific configlet.
nameStringNY Y * YConfiglet Name
The Name cannot exceed 255 characters. Allowable characters include dash (-), underscore (_), letters, and numbers and period (.).
You cannot have two configlets with the same name in one domain.
latest-versionStringYY N NLatest Version
Latest version of the configlet.

Default: "1.0".
categoryStringNY Y YCategory
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. Allowable characters include dash (-), underscore (_), letters, and numbers and period (.).
descriptionStringNY Y YDescription
Description of the configlet and it cannot exceed 2500 characters.
contextStringNY Y YContext
The context for which the configlet would be applicable for.
i.e., Configlet could be restricted to apply only on specific elements(devices, physical interfaces). So that it would not be applicable/visible to other elements
Example :
1./device[name="EX4200-200"]
2./device[name="EX4200-200"]/configuration/interfaces/interface/unit
.
reference-numberIntegerNY Y YReference Number
Reference Number is an arbitrary value which can be used for filtering the configlet.

Min: 1 Max: 65535.
device-familyStringNY Y * YDevice Family
The device family for which the configlet will be applicable for.
execution-typeenum(execution-type)NY Y YTypes of Execution
There are two types of execution types. Based on this type configlet would be available to apply on number of selected elements.
TypeDescription
SINGLEThe configlet can be applied to only one element at a time
GROUPEDThe configlet can be applied to multiple elements(devices) at a time
.

Possible Values:
SINGLESingle
GROUPEDGrouped

Default: SINGLE.
preview-show-parametersBooleanNY Y YPre-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-configurationBooleanNY Y YPre-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-parametersBooleanNY Y YPost 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-configurationBooleanNY Y YPost-view Show Configuration
Setting this option as true enables user to view applied consolidated configuration after applying the configlet.

Default: true.
domain-idIntegerYY N NDomain ID
It specifies the domain ID for which this configlet belongs to.
domain-nameStringYY N NDomain Name
Name of the domain for which the configlet belongs to.
creation-timeDateYY N NCreation Time
The time when the configlet was created.
last-updated-timeDateYY N NLast Modified Time
The time when the configlet was updated at last.
last-modified-byStringYY N NLast Modified user
The name of the user who modified the configlet at last.
cli-textStringNY Y * YConfiglet content
The actual configlet configuration is configured here
The syntax of the configlet could be as VTL template(https://velocity.apache.org/engine/releases/velocity-1.5/user-guide.html).
cli-configlet-paramscli-configlet.templateParamsNY Y YList of Configlet parameter's details.
compute-parameter-valuesStringYY N NThis API is used to compute(retrieve) parameter values based on the xpaths defined in that parameter of the configle. This value is fetched against device configuration xml

Hyperlink Template: /api/space/configuration-management/cli-configlets/{*ID}/compute-parameter-values.
apply-cli-configletStringYY N NThis API is used to apply a configlet on the device

Hyperlink Template: /api/space/configuration-management/cli-configlets/{*ID}/apply-cli-configlet.
submit-cli-configletStringYY N NThis API is used to apply a configlet on the device

Hyperlink Template: /api/space/configuration-management/cli-configlets/{*ID}/submit-cli-configlet.
applicable-devicesStringYY N NThis 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-configletStringYY N NThis API is used to validate a configlet on the device

Hyperlink Template: /api/space/configuration-management/cli-configlets/{*ID}/validate-cli-configlet.

cli-configlet.templateParams

List of Configlet parameter's details.

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this templateParams node in the current node context. This link can be used to retrieve or operate on the currently referenced templateParams in the tree path.

Hyperlink Template: /api/space/configuration-management/cli-configlets/{*ID}/cli-configlet-params.
@totalIntegerYY N Total number of gen_cli-configlet-template-params in the API result set. If paging parameters are used in the query to limit the result set size, then total represents the total number of gen_cli-configlet-template-params in all the pages of the result set.
cli-configlet-paramcli-configlet.templateParams.cliTemplateAdvanceConfig[]NY Y * Configlet parameter details.

cli-configlet.templateParams.cliTemplateAdvanceConfig

Configlet parameter details

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)YY N NNLink to this cliTemplateAdvanceConfig node in the current node context. This link can be used to retrieve or operate on the currently referenced cliTemplateAdvanceConfig in the tree path.
idIntegerYY N NNConfiglet Parameter ID
Unique key for the parameter of the configlet.
parameterStringNY Y * NNParameter Name
The name of the parameter as used in the configlet.
display-nameStringNY Y * NNDisplay Name
User friendly name for the parameter.
descriptionStringNY Y NNDescription
Description for the parameter.
parameter-scopeenum(parameter-scope)NY Y NNConfiglet Parameter Scope
It can take one of the following values
ScopeDescription
GLOBALThe parameter will be global(common) for all the selected objects
DEVICEThe parameter will be specific for all the selected individual objects(device)
ENTITYThe parameter will be specific for all the selected individual objects(entity)
.

Possible Values:
GLOBALGlobal
DEVICEDevice Specific
ENTITYEntity Specific
.
parameter-typeenum(parameter-type)NY Y * NNConfiglet Parameter Type
It can take one of the following values
TypeDescription
READWRITEThis field is for getting the value from the user while executing the configlet.
The default value for this field can either be configured with an XPath in the field Configured Value XPath or with a plain string in the field Default Value.
This returns a single value
READONLYThis field is for getting the value from the user while executing this configlet.
The default value for this field can either be configured with an XPath in the field Configured Value XPath or with a plain string in the field Default Value.
The options can be configured by an XPath in the field Selection Values Xpath, or by a csv string in the field Selection Values.
This returns a single value.
Note: Though this returns a single value, the return value is of array type and the selected value can be taken from index 0
INVISIBLEThis field cannot be edited by the user.
This parameter refers to values either defined explicitly as a csv string in the field Default Value field or by an Xpath in the field Configured Value XPath.
This field returns an array of values
PASSWORDThis parameter refers to password characters
PASSWORDCONFIRMThis parameter refers to password confirmation field
.

Possible Values:
READWRITEText Field
READONLYSelection Field
INVISIBLEInvisible Field
PASSWORDPassword Field
PASSWORDCONFIRMPassword Confirm Field
.
regex-valueStringNY Y NNRegex 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:
TypeParameter Scope
GLOBALDEVICEENTITYDefault
READWRITE A A A A
READONLY NA NA NA NA
INVISIBLE NA NA NA NA
PASSWORD A A A A
PASSWORDCONFIRM A A A A
.
configured-value-xpathStringNY Y NNConfigured 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:
TypeParameter Scope
GLOBALDEVICEENTITYDefault
READWRITE NA A A A
READONLY NA A A A
INVISIBLE NA A A A
PASSWORD NA NA NA NA
PASSWORDCONFIRM NA NA NA NA

Example : /device/interface-information/physical-interface/name/text().
default-valueStringNY Y NNDefault 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:
TypeParameter Scope
GLOBALDEVICEENTITYDefault
READWRITE A A A A
READONLY A A A A
INVISIBLE A A A A
PASSWORD NA NA NA NA
PASSWORDCONFIRM NA NA NA NA
.
selection-values-xpathStringNY Y NNSelection 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:
TypeParameter Scope
GLOBALDEVICEENTITYDefault
READWRITE NA NA NA NA
READONLY NA A A A
INVISIBLE NA NA NA NA
PASSWORD NA NA NA NA
PASSWORDCONFIRM NA NA NA NA

Example : /device/interface-information/physical-interface/name/text().
selection-valuesStringNY Y NNSelection 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:
TypeParameter Scope
GLOBALDEVICEENTITYDefault
READWRITE NA NA NA NA
READONLY A A A A
INVISIBLE NA NA NA NA
PASSWORD NA NA NA NA
PASSWORDCONFIRM NA NA NA NA
.
orderIntegerNY Y * NNOrder
The order in which the parameters would be listed while applying.

Min: 1 Max: 65535.

cli-configlet (vnd.net.juniper.space.application-management.platform.settings.cli-configlet;version=1)

The 'cliconfiglet' resource model represents details of "cliconfiglet" settings on Junos Space. It consists of following fields:

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)NY Y Link to this cli-configlet node in the current node context. This link can be used to retrieve or operate on the currently referenced cli-configlet in the tree path.
cli-configlet-approval-workflowBooleanNY Y * Authentication Mode.
advanced-xpath-processingBooleanNY Y * Advanced XPath Processing.

Cli-configlet_patch (vnd.net.juniper.space.configuration-management.cli-configlet_patch;version=3)

cli-configlet-param (vnd.net.juniper.space.configuration-management.cli-configlet-param;version=3)

Configlet parameter details

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this cli-configlet-param node in the current node context. This link can be used to retrieve or operate on the currently referenced cli-configlet-param in the tree path.
idIntegerNY Y * Configlet Parameter ID
Unique key for the parameter of the configlet.
configlet-idIntegerNY Y * Configlet ID
The ID of the configlet for which the parameter belongs to.
parameterStringNY Y * Parameter Name
The name of the parameter as used in the configlet.
display-nameStringNY Y * Display Name
User friendly name for the parameter.
descriptionStringNY Y * Description
Description for the parameter.
parameter-scopeenum(parameter-scope)NY Y Configlet Parameter Scope
It can take one of the following values
ScopeDescription
GLOBALThe parameter will be global(common) for all the selected objects
DEVICEThe parameter will be specific for all the selected individual objects(device)
ENTITYThe parameter will be specific for all the selected individual objects(entity)
.

Possible Values:
GLOBALGlobal
DEVICEDevice Specific
ENTITYEntity Specific
.
parameter-typeenum(parameter-type)NY Y * Configlet Parameter Type
It can take one of the following values
TypeDescription
READWRITEThis field is for getting the value from the user while executing the configlet.
The default value for this field can either be configured with an XPath in the field Configured Value XPath or with a plain string in the field Default Value.
This returns a single value
READONLYThis field is for getting the value from the user while executing this configlet.
The default value for this field can either be configured with an XPath in the field Configured Value XPath or with a plain string in the field Default Value.
The options can be configured by an XPath in the field Selection Values Xpath, or by a csv string in the field Selection Values.
This returns a single value.
Note: Though this returns a single value, the return value is of array type and the selected value can be taken from index 0
INVISIBLEThis field cannot be edited by the user.
This parameter refers to values either defined explicitly as a csv string in the field Default Value field or by an Xpath in the field Configured Value XPath.
This field returns an array of values
PASSWORDThis parameter refers to password characters
PASSWORDCONFIRMThis parameter refers to password confirmation field
.

Possible Values:
READWRITEText Field
READONLYSelection Field
INVISIBLEInvisible Field
PASSWORDPassword Field
PASSWORDCONFIRMPassword Confirm Field
.
regex-valueStringNY 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:
TypeParameter Scope
GLOBALDEVICEENTITYDefault
READWRITE A A A A
READONLY NA NA NA NA
INVISIBLE NA NA NA NA
PASSWORD A A A A
PASSWORDCONFIRM A A A A
.
configured-value-xpathStringNY 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:
TypeParameter Scope
GLOBALDEVICEENTITYDefault
READWRITE NA A A A
READONLY NA A A A
INVISIBLE NA A A A
PASSWORD NA NA NA NA
PASSWORDCONFIRM NA NA NA NA

Example : /device/interface-information/physical-interface/name/text().
default-valueStringNY 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:
TypeParameter Scope
GLOBALDEVICEENTITYDefault
READWRITE A A A A
READONLY A A A A
INVISIBLE A A A A
PASSWORD NA NA NA NA
PASSWORDCONFIRM NA NA NA NA
.
selection-values-xpathStringNY 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:
TypeParameter Scope
GLOBALDEVICEENTITYDefault
READWRITE NA NA NA NA
READONLY NA A A A
INVISIBLE NA NA NA NA
PASSWORD NA NA NA NA
PASSWORDCONFIRM NA NA NA NA

Example : /device/interface-information/physical-interface/name/text().
selection-valuesStringNY 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:
TypeParameter Scope
GLOBALDEVICEENTITYDefault
READWRITE NA NA NA NA
READONLY A A A A
INVISIBLE NA NA NA NA
PASSWORD NA NA NA NA
PASSWORDCONFIRM NA NA NA NA
.
orderIntegerNY Y * Order
The order in which the parameters would be listed while applying.

Min: 1 Max: 65535.
dependent-parameter-listcli-configlet-param.dependentParameterListsNY Y * List of dependent parameter details.

cli-configlet-param.dependentParameterLists

List of dependent parameter details

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this dependentParameterLists node in the current node context. This link can be used to retrieve or operate on the currently referenced dependentParameterLists in the tree path.
dependent-parametercli-configlet-param.dependentParameterLists.configletParamForNBI[]NY Y * Dependent parameter
Dependent parameter is a parameter which is referred in some other parameters.

cli-configlet-param.dependentParameterLists.configletParamForNBI

Dependent parameter
Dependent parameter is a parameter which is referred in some other parameters

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)YY N NNLink to this configletParamForNBI node in the current node context. This link can be used to retrieve or operate on the currently referenced configletParamForNBI in the tree path.
parametercli-configlet-param.dependentParameterLists.configletParamForNBI.paramForNBIYY N NNparameter
Parameter which is referred by other parameters in xpath.

cli-configlet-param.dependentParameterLists.configletParamForNBI.paramForNBI

parameter
Parameter which is referred by other parameters in xpath

Field NameTypeRead OnlyGETPUT / POSTDescription
@hrefString(URI)NY Y * Link to an external paramForNBI. Here, href points to the paramForNBI in the primary paramForNBI collection.

Hyperlink Template: /api/space/configuration-management/cli-configlets/{*ID}/cli-configlet-params/{*ID}.
param-idIntegerYY N Configlet Parameter ID
Unique ID of the parameter.

Default: 0.
nameStringYY N Parameter Name
Name of the parameter.
configlet-idIntegerYY N Configlet ID
Unique Id of the configlet.

Default: 0.

cli-configlet-params (vnd.net.juniper.space.configuration-management.cli-configlet-params;version=3)

List of configlet parameter details

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this cli-configlet-params node in the current node context. This link can be used to retrieve or operate on the currently referenced cli-configlet-params in the tree path.
@totalIntegerYY N Total number of cli-configlet-params in the API result set. If paging parameters are used in the query to limit the result set size, then total represents the total number of cli-configlet-params in all the pages of the result set.
cli-configlet-paramcli-configlet-params.cliTemplateAdvanceConfig[]NY Y * Configlet parameter details.

cli-configlet-params.cliTemplateAdvanceConfig

Configlet parameter details

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@hrefString(URI)YY N NNLink to an external cliTemplateAdvanceConfig. Here, href points to the cliTemplateAdvanceConfig in the primary cliTemplateAdvanceConfig collection.

Hyperlink Template: /api/space/configuration-management/cli-configlets/{*ID}/cli-configlet-params/{*ID}.
idIntegerYY N NNConfiglet Parameter ID
Unique key for the parameter of the configlet.
configlet-idIntegerYY N NNConfiglet ID
The ID of the configlet for which the parameter belongs to.
parameterStringNY Y * NNParameter Name
The name of the parameter as used in the configlet.
display-nameStringNY Y * NNDisplay Name
User friendly name for the parameter.
descriptionStringNY Y * NNDescription
Description for the parameter.
parameter-scopeenum(parameter-scope)NY Y NNConfiglet Parameter Scope
It can take one of the following values
ScopeDescription
GLOBALThe parameter will be global(common) for all the selected objects
DEVICEThe parameter will be specific for all the selected individual objects(device)
ENTITYThe parameter will be specific for all the selected individual objects(entity)
.

Possible Values:
GLOBALGlobal
DEVICEDevice Specific
ENTITYEntity Specific
.
parameter-typeenum(parameter-type)NY Y NNConfiglet Parameter Type
It can take one of the following values
TypeDescription
READWRITEThis field is for getting the value from the user while executing the configlet.
The default value for this field can either be configured with an XPath in the field Configured Value XPath or with a plain string in the field Default Value.
This returns a single value
READONLYThis field is for getting the value from the user while executing this configlet.
The default value for this field can either be configured with an XPath in the field Configured Value XPath or with a plain string in the field Default Value.
The options can be configured by an XPath in the field Selection Values Xpath, or by a csv string in the field Selection Values.
This returns a single value.
Note: Though this returns a single value, the return value is of array type and the selected value can be taken from index 0
INVISIBLEThis field cannot be edited by the user.
This parameter refers to values either defined explicitly as a csv string in the field Default Value field or by an Xpath in the field Configured Value XPath.
This field returns an array of values
PASSWORDThis parameter refers to password characters
PASSWORDCONFIRMThis parameter refers to password confirmation field
.

Possible Values:
READWRITEText Field
READONLYSelection Field
INVISIBLEInvisible Field
PASSWORDPassword Field
PASSWORDCONFIRMPassword Confirm Field
.
regex-valueStringNY Y * NNRegex 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:
TypeParameter Scope
GLOBALDEVICEENTITYDefault
READWRITE A A A A
READONLY NA NA NA NA
INVISIBLE NA NA NA NA
PASSWORD A A A A
PASSWORDCONFIRM A A A A
.
configured-value-xpathStringNY Y * NNConfigured 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:
TypeParameter Scope
GLOBALDEVICEENTITYDefault
READWRITE NA A A A
READONLY NA A A A
INVISIBLE NA A A A
PASSWORD NA NA NA NA
PASSWORDCONFIRM NA NA NA NA

Example : /device/interface-information/physical-interface/name/text().
default-valueStringNY Y * NNDefault 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:
TypeParameter Scope
GLOBALDEVICEENTITYDefault
READWRITE A A A A
READONLY A A A A
INVISIBLE A A A A
PASSWORD NA NA NA NA
PASSWORDCONFIRM NA NA NA NA
.
selection-values-xpathStringNY Y NNSelection 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:
TypeParameter Scope
GLOBALDEVICEENTITYDefault
READWRITE NA NA NA NA
READONLY NA A A A
INVISIBLE NA NA NA NA
PASSWORD NA NA NA NA
PASSWORDCONFIRM NA NA NA NA

Example : /device/interface-information/physical-interface/name/text().
selection-valuesStringNY Y NNSelection 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:
TypeParameter Scope
GLOBALDEVICEENTITYDefault
READWRITE NA NA NA NA
READONLY A A A A
INVISIBLE NA NA NA NA
PASSWORD NA NA NA NA
PASSWORDCONFIRM NA NA NA NA
.
orderIntegerNY Y * NNOrder
The order in which the parameters would be listed while applying.

Min: 1 Max: 65535.
read-onlyBooleanYY N NNRead Only
True refers the parameter can be edited/deleted when it is under the Base configlet. Base configlet in turn a configlet includes/refers other configlet using directive(#mixin or #include_configlet).

Default: false.
dependent-parameter-listcli-configlet-params.cliTemplateAdvanceConfig.dependentParameterListsNY Y NNList of dependent parameter details.

cli-configlet-params.cliTemplateAdvanceConfig.dependentParameterLists

List of dependent parameter details

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this dependentParameterLists node in the current node context. This link can be used to retrieve or operate on the currently referenced dependentParameterLists in the tree path.
dependent-parametercli-configlet-params.cliTemplateAdvanceConfig.dependentParameterLists.configletParamForNBI[]NY Y * Dependent parameter
Dependent parameter is a parameter which is referred in some other parameters.

cli-configlet-params.cliTemplateAdvanceConfig.dependentParameterLists.configletParamForNBI

Dependent parameter
Dependent parameter is a parameter which is referred in some other parameters

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)YY N NNLink to this configletParamForNBI node in the current node context. This link can be used to retrieve or operate on the currently referenced configletParamForNBI in the tree path.
parametercli-configlet-params.cliTemplateAdvanceConfig.dependentParameterLists.configletParamForNBI.paramForNBIYY N NNparameter
Parameter which is referred by other parameters in xpath.

cli-configlet-params.cliTemplateAdvanceConfig.dependentParameterLists.configletParamForNBI.paramForNBI

parameter
Parameter which is referred by other parameters in xpath

Field NameTypeRead OnlyGETPUT / POSTDescription
@hrefString(URI)NY Y * Link to an external paramForNBI. Here, href points to the paramForNBI in the primary paramForNBI collection.

Hyperlink Template: /api/space/configuration-management/cli-configlets/{*ID}/cli-configlet-params/{*ID}.
param-idIntegerYY N Configlet Parameter ID
Unique ID of the parameter.

Default: 0.
nameStringYY N Parameter Name
Name of the parameter.
configlet-idIntegerYY N Configlet ID
Unique Id of the configlet.

Default: 0.

cli-configlets (vnd.net.juniper.space.configuration-management.cli-configlets;version=3)

List of configlets available in space

Field NameTypeRead OnlyGETPUT / POSTPATCHDescription
@uriString(URI)YY N NLink to this cli-configlets node in the current node context. This link can be used to retrieve or operate on the currently referenced cli-configlets in the tree path.
@totalIntegerYY N NTotal number of cli-configlets in the API result set. If paging parameters are used in the query to limit the result set size, then total represents the total number of cli-configlets in all the pages of the result set.
cli-configletcli-configlets.cliConfigurationTemplate[]NY Y * YConfiglet details.

cli-configlets.cliConfigurationTemplate

Configlet details

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)YY N NNLink to this cliConfigurationTemplate node in the current node context. This link can be used to retrieve or operate on the currently referenced cliConfigurationTemplate in the tree path.

Hyperlink Template: /api/space/configuration-management/cli-configlets/{*ID}.
@hrefString(URI)YY N NNLink to an external cliConfigurationTemplate. Here, href points to the cliConfigurationTemplate in the primary cli-configlets collection.

Hyperlink Template: /api/space/configuration-management/cli-configlets/{*ID}.
idIntegerYY N NNConfiglet ID
This is the unique key value used to access/identify the specific configlet.
nameStringNY Y * YYConfiglet Name
The Name cannot exceed 255 characters. Allowable characters include dash (-), underscore (_), letters, and numbers and period (.).
You cannot have two configlets with the same name in one domain.
latest-versionStringYY N YYLatest Version
Latest version of the configlet.

Default: "1.0".
categoryStringNY Y YYCategory
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. Allowable characters include dash (-), underscore (_), letters, and numbers and period (.).
descriptionStringNY Y NNDescription
Description of the configlet and it cannot exceed 2500 characters.
device-familyStringNY Y * YYDevice Family
The device family for which the configlet will be applicable for.
execution-typeenum(execution-type)NY Y YYTypes of Execution
There are two types of execution types. Based on this type configlet would be available to apply on number of selected elements.
TypeDescription
SINGLEThe configlet can be applied to only one element at a time
GROUPEDThe configlet can be applied to multiple elements(devices) at a time
.

Possible Values:
SINGLESingle
GROUPEDGrouped

Default: SINGLE.
reference-numberIntegerNY Y YYReference Number
Reference Number is an arbitrary value which can be used for filtering the configlet.

Min: 1 Max: 65535.
domain-idIntegerYY N NNDomain ID
It specifies the domain ID for which this configlet belongs to.
domain-nameStringYY N NNDomain Name
Name of the domain for which the configlet belongs to.
creation-timeDateYY N YYCreation Time
The time when the configlet was created.
last-updated-timeDateYY N YYLast Modified Time
The time when the configlet was updated at last.
last-modified-byStringYY N YYLast Modified user
The name of the user who modified the configlet at last.

Cli-configlets_patch (vnd.net.juniper.space.configuration-management.cli-configlets_patch;version=3)

clone-request (vnd.net.juniper.space.device-management.clone-request;version=1)

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this clone-request node in the current node context. This link can be used to retrieve or operate on the currently referenced clone-request in the tree path.
cloned-device-nameStringNY Y * Name of the cloned device.
device-countIntegerNY Y * Number of clones to be created. If more than one device is generated, the name would be _#NUMBER for each so that each device would have a unique name.
image-upgrade-validationBooleanNY Y * Possible values 1.image-upgrade-validation - "false" : Remove existing image association(if any) and no associated image present. 2.image-upgrade-validation - "true" - device-image - none : Accept existing image association(if any) 3.image-upgrade-validation - true - device-image - provided :Accept given image for association.
device-imageclone-request.deviceImageNY Y  

clone-request.deviceImage

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this deviceImage node in the current node context. This link can be used to retrieve or operate on the currently referenced deviceImage in the tree path.
@hrefString(URI)NY Y * Link to an external deviceImage. Here, href points to the deviceImage in the primary deviceImage collection.

Hyperlink Template: /api/space/software-management/packages/{*ID}.
idIntegerYY N Id of the Image.
nameStringNY Y Name of the image file(optional field).

clone-template-request (vnd.net.juniper.space.config-template-management.clone-template-request;version=2)

Field NameTypeRead OnlyGETPUT / POSTDescription
template-nameStringNY Y * Template Name.
template-descStringNY Y * Template Desc.

clone-template-response (vnd.net.juniper.space.config-template-management.clone-template-response;version=2)

Field NameTypeRead OnlyGETPUT / POSTDescription
valueIntegerNY Y * Value.

compare-config-by-devices-request (vnd.net.juniper.space.config-template-management.compare-config-by-devices-request;version=2)

Field NameTypeRead OnlyGETPUT / POSTDescription
device-idscompare-config-by-devices-request.deviceIDsNY Y *  
compare-device-configbooleanNY Y *  

compare-config-by-devices-request.deviceIDs

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this deviceIDs node in the current node context. This link can be used to retrieve or operate on the currently referenced deviceIDs in the tree path.
device-idInteger[]NY Y * Device IDs.

compute-configlet-parameter-values-request (vnd.net.juniper.space.device-management.compute-configlet-parameter-values-request;version=5)

Compute parameter details
Values of the parameters could be populated based on the default values or given xpath in the parameter definition

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this compute-configlet-parameter-values-request node in the current node context. This link can be used to retrieve or operate on the currently referenced compute-configlet-parameter-values-request in the tree path.
configletcompute-configlet-parameter-values-request.cliConfigurationTemplateNY Y * Configlet details Parameter's value for this configlet would be calculated.
compute-configlet-parameter-valuescompute-configlet-parameter-values-request.computeParameterListsNY Y Compute parameter list
List of parameters only for which parameter value would be computed. If none of parameter is specified then values for all the parameters would be populated.

compute-configlet-parameter-values-request.cliConfigurationTemplate

Configlet details Parameter's value for this configlet would be calculated

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this cliConfigurationTemplate node in the current node context. This link can be used to retrieve or operate on the currently referenced cliConfigurationTemplate in the tree path.
@hrefString(URI)NY Y * Link to an external cliConfigurationTemplate. Here, href points to the cliConfigurationTemplate in the primary cliConfigurationTemplate collection.

Hyperlink Template: /api/space/configuration-management/cli-configlets/{*ID}.
idIntegerYY N configlet ID This is the unique key value used to access/identify the specific configlet.
nameStringYY N Name of the configlet
The Name cannot exceed 255 characters. Allowable characters include dash (-), underscore (_), letters, and numbers and period (.).
You cannot have two configlets with the same name.

compute-configlet-parameter-values-request.computeParameterLists

Compute parameter list
List of parameters only for which parameter value would be computed. If none of parameter is specified then values for all the parameters would be populated.

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this computeParameterLists node in the current node context. This link can be used to retrieve or operate on the currently referenced computeParameterLists in the tree path.
compute-configlet-parameter-valuecompute-configlet-parameter-values-request.computeParameterLists.computeParameterValuesList[]NY Y * Compute Configlet Parameter Value
Configlet parameter for which value to be computed.

compute-configlet-parameter-values-request.computeParameterLists.computeParameterValuesList

Compute Parameter Value
Configlet parameter for which value to be computed

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)YY N NNLink to this computeParameterValuesList node in the current node context. This link can be used to retrieve or operate on the currently referenced computeParameterValuesList in the tree path.
parametercompute-configlet-parameter-values-request.computeParameterLists.computeParameterValuesList.paramForNBINY Y * NNParameter
Details of the configlet parameter.
dependent-parameter-valuescompute-configlet-parameter-values-request.computeParameterLists.computeParameterValuesList.dependentValuesNY Y NNDependent parameter list
List of dependent parameters are referred by this parameter. Based on this dependent parameter, value will be fetched and default value for the dependent parameter is null.

compute-configlet-parameter-values-request.computeParameterLists.computeParameterValuesList.paramForNBI

Parameter
Details of the configlet parameter

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this paramForNBI node in the current node context. This link can be used to retrieve or operate on the currently referenced paramForNBI in the tree path.
@hrefString(URI)NY Y * Link to an external paramForNBI. Here, href points to the paramForNBI in the primary paramForNBI collection.

Hyperlink Template: /api/space/configuration-management/cli-configlets/{*ID}/cli-configlet-params/{*ID}.
param-idIntegerYY N Configlet Parameter ID
Unique ID for the configlet parameter.
Default: 0.
nameStringYY N Parameter Name
Name of the parameter.
configlet-idIntegerYY N Configlet ID
Unique ID for the configlet.

compute-configlet-parameter-values-request.computeParameterLists.computeParameterValuesList.dependentValues

Dependent parameter list
List of dependent parameters are referred by this parameter. Based on this dependent parameter, value will be fetched and default value for the dependent parameter is null

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this dependentValues node in the current node context. This link can be used to retrieve or operate on the currently referenced dependentValues in the tree path.
@totalIntegerYY N Total number of gen_compute-configlet-parameter-values-request-compute-parameter-list-compute-parameter-lists-dependent-values in the API result set. If paging parameters are used in the query to limit the result set size, then total represents the total number of gen_compute-configlet-parameter-values-request-compute-parameter-list-compute-parameter-lists-dependent-values in all the pages of the result set.
dependent-parameter-valuecompute-configlet-parameter-values-request.computeParameterLists.computeParameterValuesList.dependentValues.configletParamForNBI[]NY Y * Dependent Parameter Details
Parameter is referred by this parameter.

compute-configlet-parameter-values-request.computeParameterLists.computeParameterValuesList.dependentValues.configletParamForNBI

Dependent Parameter Details
Parameter is referred by this parameter

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)YY N NNLink to this configletParamForNBI node in the current node context. This link can be used to retrieve or operate on the currently referenced configletParamForNBI in the tree path.
parametercompute-configlet-parameter-values-request.computeParameterLists.computeParameterValuesList.dependentValues.configletParamForNBI.paramForNBINY Y * NNParameter
Details of the parameter.
parameter-valueStringNY Y * NNParameter Value
Value of the dependent parameter.

compute-configlet-parameter-values-request.computeParameterLists.computeParameterValuesList.dependentValues.configletParamForNBI.paramForNBI

Parameter
Details of the configlet parameter

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this paramForNBI node in the current node context. This link can be used to retrieve or operate on the currently referenced paramForNBI in the tree path.
@hrefString(URI)NY Y * Link to an external paramForNBI. Here, href points to the paramForNBI in the primary paramForNBI collection.

Hyperlink Template: /api/space/configuration-management/cli-configlets/{*ID}/cli-configlet-params/{*ID}.
parameter-idIntegerYY N Configlet Parameter ID
Unique ID for the configlet parameter.
Default: 0.
nameStringYY N Parameter Name
Name of the parameter.
configlet-idIntegerYY N Configlet ID
This is the unique key value used to access/identify the specific configlet.

compute-configlet-parameter-values-response (vnd.net.juniper.space.device-management.compute-configlet-parameter-values-response;version=5)

List of computed configlet parameter values

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this compute-configlet-parameter-values-response node in the current node context. This link can be used to retrieve or operate on the currently referenced compute-configlet-parameter-values-response in the tree path.
compute-configlet-parameter-valuescompute-configlet-parameter-values-response.computedParameterValuesNY Y * Computed Configlet parameter list.

compute-configlet-parameter-values-response.computedParameterValues

Computed configlet parameter list

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this computedParameterValues node in the current node context. This link can be used to retrieve or operate on the currently referenced computedParameterValues in the tree path.
compute-configlet-parameter-valuecompute-configlet-parameter-values-response.computedParameterValues.computeParameterValuesList[]NY Y * Computed configlet parameter details
Parameter values based on the given dependent parameter values or xpath expression defined in the parameter definition.

compute-configlet-parameter-values-response.computedParameterValues.computeParameterValuesList

Computed configlet parameter name and its value details

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)YY N NNLink to this computeParameterValuesList node in the current node context. This link can be used to retrieve or operate on the currently referenced computeParameterValuesList in the tree path.
parametercompute-configlet-parameter-values-response.computedParameterValues.computeParameterValuesList.paramForNBINY Y * NNParameter details
Parameter for which values are computed.
parameter-valueStringNY Y NNParameter Value
Value of the parameter.
possible-valuescompute-configlet-parameter-values-response.computedParameterValues.computeParameterValuesList.possibleValuesNY Y NNPossible Values
List of possible values for the parameter.

compute-configlet-parameter-values-response.computedParameterValues.computeParameterValuesList.paramForNBI

Parameter details
Parameter for which values are computed

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this paramForNBI node in the current node context. This link can be used to retrieve or operate on the currently referenced paramForNBI in the tree path.
@hrefString(URI)NY Y * Link to an external paramForNBI. Here, href points to the paramForNBI in the primary paramForNBI collection.

Hyperlink Template: /api/space/configuration-management/cli-configlets/{*ID}/cli-configlet-params/{*ID}.
parameter-idIntegerYY N Configlet Parameter ID
Unique ID for the configlet parameter.
Default: 0.
nameStringYY N Parameter Name
Name of the parameter.
configlet-idIntegerYY N Configlet ID
Unique ID for the configlet.

compute-configlet-parameter-values-response.computedParameterValues.computeParameterValuesList.possibleValues

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this possibleValues node in the current node context. This link can be used to retrieve or operate on the currently referenced possibleValues in the tree path.
@totalIntegerYY N Total number of gen_compute-configlet-parameter-values-response-computed-parameter-values-computed-parameter-values-possible-values in the API result set. If paging parameters are used in the query to limit the result set size, then total represents the total number of gen_compute-configlet-parameter-values-response-computed-parameter-values-computed-parameter-values-possible-values in all the pages of the result set.
possible-valueString[]NY Y * Possible Values.

compute-parameter-values-request (vnd.net.juniper.space.configuration-management.compute-parameter-values-request;version=3)

Compute parameter details
Values of the parameters could be populated based on the default values or given xpath in the parameter definition

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this compute-parameter-values-request node in the current node context. This link can be used to retrieve or operate on the currently referenced compute-parameter-values-request in the tree path.
devicecompute-parameter-values-request.deviceNY Y * Device details
Xpath values will be evaluated against the given device configuration.
compute-parameter-valuescompute-parameter-values-request.computeParameterListsNY Y Compute parameter list
List of parameters only for which parameter value would be computed. If none of parameter is specified then values for all the parameters would be populated.

compute-parameter-values-request.device

Device details
Xpath values will be evaluated against the given device configuration

Field NameTypeRead OnlyGETPUT / POSTDescription
@hrefString(URI)NY Y * Link to an external device. Here, href points to the device in the primary device collection.

Hyperlink Template: /api/space/device-management/devices/{*ID}.
idIntegerYY N Device ID
Unique ID of the device.
nameStringYY N Device Name.

compute-parameter-values-request.computeParameterLists

Compute parameter list
List of parameters only for which parameter value would be computed. If none of parameter is specified then values for all the parameters would be populated.

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this computeParameterLists node in the current node context. This link can be used to retrieve or operate on the currently referenced computeParameterLists in the tree path.
compute-parameter-valuecompute-parameter-values-request.computeParameterLists.computeParameterValuesList[]NY Y * Compute Parameter Value
Configlet parameter for which value to be computed.

compute-parameter-values-request.computeParameterLists.computeParameterValuesList

Compute Parameter Value
Configlet parameter for which value to be computed

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)YY N NNLink to this computeParameterValuesList node in the current node context. This link can be used to retrieve or operate on the currently referenced computeParameterValuesList in the tree path.
parametercompute-parameter-values-request.computeParameterLists.computeParameterValuesList.paramForNBINY Y * NNParameter
Details of the configlet parameter.
dependent-parameter-valuescompute-parameter-values-request.computeParameterLists.computeParameterValuesList.dependentValuesNY Y NNDependent parameter list
List of dependent parameters are referred by this parameter. Based on this dependent parameter, value will be fetched and default value for the dependent parameter is null.

compute-parameter-values-request.computeParameterLists.computeParameterValuesList.paramForNBI

Parameter
Details of the configlet parameter

Field NameTypeRead OnlyGETPUT / POSTDescription
@hrefString(URI)NY Y * Link to an external paramForNBI. Here, href points to the paramForNBI in the primary paramForNBI collection.

Hyperlink Template: /api/space/configuration-management/cli-configlets/{*ID}/cli-configlet-params/{*ID}.
param-idIntegerYY N Configlet Parameter ID
Unique Id for the configlet parameter.
Default: 0.

Default: 0.
nameStringYY N Parameter Name
Name of the parameter.
configlet-idIntegerYY N Configlet ID
Unique Id for the configlet.

compute-parameter-values-request.computeParameterLists.computeParameterValuesList.dependentValues

Dependent parameter list
List of dependent parameters are referred by this parameter. Based on this dependent parameter, value will be fetched and default value for the dependent parameter is null

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this dependentValues node in the current node context. This link can be used to retrieve or operate on the currently referenced dependentValues in the tree path.
@totalIntegerYY N Total number of gen_compute-parameter-values-request-compute-parameter-list-compute-parameter-lists-dependent-values in the API result set. If paging parameters are used in the query to limit the result set size, then total represents the total number of gen_compute-parameter-values-request-compute-parameter-list-compute-parameter-lists-dependent-values in all the pages of the result set.
dependent-parameter-valuecompute-parameter-values-request.computeParameterLists.computeParameterValuesList.dependentValues.configletParamForNBI[]NY Y * Dependent Parameter Details
Parameter is referred by this parameter.

compute-parameter-values-request.computeParameterLists.computeParameterValuesList.dependentValues.configletParamForNBI

Dependent Parameter Details
Parameter is referred by this parameter

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)YY N NNLink to this configletParamForNBI node in the current node context. This link can be used to retrieve or operate on the currently referenced configletParamForNBI in the tree path.
parametercompute-parameter-values-request.computeParameterLists.computeParameterValuesList.dependentValues.configletParamForNBI.paramForNBINY Y NNParameter
Details of the parameter.
parameter-valueStringNY Y * NNParameter Value
Value of the dependent parameter.

compute-parameter-values-request.computeParameterLists.computeParameterValuesList.dependentValues.configletParamForNBI.paramForNBI

Parameter
Details of the configlet parameter

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this paramForNBI node in the current node context. This link can be used to retrieve or operate on the currently referenced paramForNBI in the tree path.
@hrefString(URI)NY Y * Link to an external paramForNBI. Here, href points to the paramForNBI in the primary paramForNBI collection.

Hyperlink Template: /api/space/configuration-management/cli-configlets/{*ID}/cli-configlet-params/{*ID}.
parameter-idIntegerYY N Configlet Parameter ID
Unique Id of the parameter.

Default: 0.
nameStringYY N Parameter Name
Name of the parameter.
configlet-idIntegerYY N Configlet ID
This is the unique key value used to access/identify the specific configlet.

compute-parameter-values-response (vnd.net.juniper.space.configuration-management.compute-parameter-values-response;version=3)

Computed parameter details

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this compute-parameter-values-response node in the current node context. This link can be used to retrieve or operate on the currently referenced compute-parameter-values-response in the tree path.
compute-parameter-valuescompute-parameter-values-response.computedParameterValuesNY Y Computed parameter value list.

compute-parameter-values-response.computedParameterValues

Computed parameter value list

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this computedParameterValues node in the current node context. This link can be used to retrieve or operate on the currently referenced computedParameterValues in the tree path.
compute-parameter-valuecompute-parameter-values-response.computedParameterValues.computeParameterValuesList[]NY Y * Computed parameter details
Parameter values based on the given dependent parameter values or xpath expression defined in the parameter definition.

compute-parameter-values-response.computedParameterValues.computeParameterValuesList

Computed parameter details
Parameter values based on the given dependent parameter values or xpath expression defined in the parameter definition

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)YY N NNLink to this computeParameterValuesList node in the current node context. This link can be used to retrieve or operate on the currently referenced computeParameterValuesList in the tree path.
parametercompute-parameter-values-response.computedParameterValues.computeParameterValuesList.paramForNBINY Y * NNParameter details
Parameter for which values are computed.
parameter-valueStringNY Y NNParameter Value
Value of the parameter.
possible-valuescompute-parameter-values-response.computedParameterValues.computeParameterValuesList.possibleValuesNY Y NNPossible Values
List of possible values for the parameter.

compute-parameter-values-response.computedParameterValues.computeParameterValuesList.paramForNBI

Parameter details
Parameter for which values are computed

Field NameTypeRead OnlyGETPUT / POSTDescription
@hrefString(URI)NY Y * Link to an external paramForNBI. Here, href points to the paramForNBI in the primary paramForNBI collection.

Hyperlink Template: /api/space/configuration-management/cli-configlets/{*ID}/cli-configlet-params/{*ID}.
parameter-idIntegerYY N Configlet Parameter ID
Unique ID of the parameter.

Default: 0.
nameStringYY N Parameter Name
Name of the parameter.
configlet-idIntegerYY N Configlet ID
Unique ID for the configlet.

compute-parameter-values-response.computedParameterValues.computeParameterValuesList.possibleValues

Possible Values
List of possible values for the parameter

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this possibleValues node in the current node context. This link can be used to retrieve or operate on the currently referenced possibleValues in the tree path.
@totalIntegerYY N Total number of gen_compute-parameter-values-response-computed-parameter-values-computed-parameter-values-possible-values in the API result set. If paging parameters are used in the query to limit the result set size, then total represents the total number of gen_compute-parameter-values-response-computed-parameter-values-computed-parameter-values-possible-values in all the pages of the result set.
possible-valueString[]NY Y * Possible Value
Possible value for the parameter.

config-file (vnd.net.juniper.space.config-file-management.config-file;version=1)

The 'config-file' resource model represents information on a device configuration file. It contains information on the device family, version, configuration file size, and other metadata.

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)NY Y Link to this config-file node in the current node context. This link can be used to retrieve or operate on the currently referenced config-file in the tree path.
latestVersionUpdateTimeStringNY Y Last time latest version was updated.
deviceFamilyStringNY Y Device family for configuration file.
fileNameStringNY Y Name of configuration file.
latestVersionIntegerNY Y Latest version of configuration file.
idintNY Y * Configuration File ID.
sizelongNY Y * Size (KB) of configuration file.
deviceNameStringNY Y Name of device associated with this configuration file.
deviceIdintNY Y * ID of device for this configuration file.
config-file-versionsconfig-file.configFileVersionMOsNY Y All versions of this configuration file.
deviceStringNY Y Device link for the device associated with this configuration file.
latest-versionStringNY Y Latest version link pointing to the the version document for this configuration file.

config-file.configFileVersionMOs

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)NY Y Link to this configFileVersionMOs node in the current node context. This link can be used to retrieve or operate on the currently referenced configFileVersionMOs in the tree path.
config-file-versionconfig-file.configFileVersionMOs.configFileVersionMO[]NY Y Configuration file version information.

config-file.configFileVersionMOs.configFileVersionMO

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@hrefString(URI)NY Y NNLink to an external configFileVersionMO. Here, href points to the configFileVersionMO in the primary configFileVersionMO collection.
@uriString(URI)NY Y NNLink to this configFileVersionMO node in the current node context. This link can be used to retrieve or operate on the currently referenced configFileVersionMO in the tree path.
idintNY Y * NNVersion ID.
versionIdintNY Y * NNInternal version id.
creationTimeStringNY Y NNTime this version was created.
commentStringNY Y NNUser specified comment for this version.

config-files (vnd.net.juniper.space.config-file-management.config-files;version=1)

The 'config-files' resource model represent a view of information about archived configuration files. It consists of following fields:

Field NameTypeRead OnlyGETPUT / POSTDescription
@sizeIntegerNY Y Total number of configuration files available in the system.
@uriString(URI)NY Y Link to this config-files node in the current node context. This link can be used to retrieve or operate on the currently referenced config-files in the tree path.
config-fileconfig-files.configFileMO[]NY Y List of configuration files.

config-files.configFileMO

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)NY Y NNLink to this configFileMO node in the current node context. This link can be used to retrieve or operate on the currently referenced configFileMO in the tree path.
@hrefString(URI)NY Y NNLink to an external configFileMO. Here, href points to the configFileMO in the primary configFileMO collection.
latestVersionUpdateTimeStringNY Y NNLast update time for latest version.
deviceFamilyStringNY Y YYDevice Family.
configFileNameStringNY Y YYName of configuration file.
latestVersionIntegerNY Y YYLatest version document for this configuration file.
idintNY Y YYConfiguration File ID.
deviceNameStringNY Y YYDevice Name associated with this configuration file.
deviceIdintNY Y YYDevice ID.
deviceStringNY Y NNDevice associated with this configuration file.
latest-versionStringNY Y NNLatest version for this configuration file.

config-file-version (vnd.net.juniper.space.config-file-management.config-file-version;version=1)

The 'config-file-version' resource model represents information about a single version of a device configuration file. Its content field contains XML config data.

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)NY Y Link to this config-file-version node in the current node context. This link can be used to retrieve or operate on the currently referenced config-file-version in the tree path.
idintNY Y * Version href ID.
fileNameStringNY Y File name.
configFileSizelongNY Y * File size for this version.
contentStringNY Y Config XML for this version.
versionIdintNY Y * Version ID.
creationTimeStringNY Y Time version was created.
commentStringNY Y User provided comment.
latestMD5StringNY Y MD5 for this version.

config-file-versions (vnd.net.juniper.space.config-file-management.config-file-versions;version=1)

The 'config-file-versions' resource model represent a view of information about archived configuration file versions. It consists of following fields: *

Field NameTypeRead OnlyGETPUT / POSTDescription
@sizeIntegerNY Y Total number of versions available in the system.
@uriString(URI)NY Y Link to this config-file-versions node in the current node context. This link can be used to retrieve or operate on the currently referenced config-file-versions in the tree path.
config-file-versionconfig-file-versions.configFileVersionMO[]NY Y A single version document.

config-file-versions.configFileVersionMO

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)NY Y NNLink to this configFileVersionMO node in the current node context. This link can be used to retrieve or operate on the currently referenced configFileVersionMO in the tree path.
@hrefString(URI)NY Y NNLink to an external configFileVersionMO. Here, href points to the configFileVersionMO in the primary configFileVersionMO collection.
idintNY Y * NNHref ID for this version.
versionIdintNY Y * NNVersion ID.
creationTimeStringNY Y NNTime version was created.
commentStringNY Y NNUser provided comment.

configlet (vnd.net.juniper.space.device-management.configlet;version=1)

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this configlet node in the current node context. This link can be used to retrieve or operate on the currently referenced configlet in the tree path.
xml-configlet-dataStringNY Y * Configlet in XML format.
curly-braces-configlet-dataStringNY Y * Configlet in Curly braces format.
cli-configlet-dataStringNY Y * Configlet in CLI format(set commands).

configlets (vnd.net.juniper.space.device-management.modeled-device-management.configlets;version=1)

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this configlets node in the current node context. This link can be used to retrieve or operate on the currently referenced configlets in the tree path.
@totalIntegerYY N Total number of configlets in the API result set. If paging parameters are used in the query to limit the result set size, then total represents the total number of configlets in all the pages of the result set.
configletconfiglets.deployDeviceConfiglet[]NY Y * Configlet which contains modeled-device configuration in CLI/CURLY BRACES/XML format.

configlets.deployDeviceConfiglet

Configlet which contains modeled-device configuration in CLI/CURLY BRACES/XML format

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@hrefString(URI)NY Y * NNLink to an external deployDeviceConfiglet. Here, href points to the deployDeviceConfiglet in the primary deployDeviceConfiglet collection.

Hyperlink Template: /api/space/device-management/devices/{*ID}/configlet.
@uriString(URI)YY N NNLink to this deployDeviceConfiglet node in the current node context. This link can be used to retrieve or operate on the currently referenced deployDeviceConfiglet in the tree path.

Hyperlink Template: /api/space/device-management/modeled-device-management/modeled-instances/{*ID}/configlets.
device-idIntegerYY N NNId of device.

config-template (vnd.net.juniper.space.config-template-management.config-template;version=1)

A configuration template represents a partial configuration that can be deployed or published to a single device or group of devices.

Field NameTypeRead OnlyGETPUT / POSTPATCHDescription
@uriString(URI)NY Y NLink to this config-template node in the current node context. This link can be used to retrieve or operate on the currently referenced config-template in the tree path.

Hyperlink Template: /api/space/config-template-management/config-templates/{*ID}.
@hrefString(URI)YY N NLink to an external config-template. Here, href points to the config-template in the primary config-template collection.

Hyperlink Template: /api/space/config-template-management/config-templates/{*ID}.
*idIntegerYY N NThe ID of the configuration template.
nameStringNY Y * YThe name of the configuration template.
descriptionStringNY Y * YA description of the configuration template.
config-typeenum(config-type)YY N NThe configuration type for the configuration template.

Possible Values:
CONFIG_TEMPLATEConfig Template
CONFIG_TEMPLATE_DEFINITION 
APP_SETTINGS 
SERVICE_TEMPLATE_DEFINITION 
CONFIG_EDITOR 
TA_TEMPLATE_DEFINITION 
SERVICE_TEMPLATE 
MONITOR_DEVICE 
API_TEMPLATE_DEFINITION 
QUICK_TEMPLATEQuick Template
.
stateStringYY N NThe state of the configuration template. Possible Values: enabled, disabled, need-review.
os-versionStringYY N NThe Junos OS version for the configuration template.
current-versionIntegerYY N NThe current version of the configuration template. The version number is incremented when the template is modified.
device-familyStringYY N NThe Junos Device family for the configuration template.
last-updated-byStringYY N NThe user who last updated this configuration template.
last-update-time-stringStringYY N NThe date and time that the configuration template was last modified.
template-deployment-statusStringYY N NThe status of the configuration template's deployment.
config-template-definitionconfig-template.configTemplateDefInfoNY Y * YA 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-nameStringNY Y YThe name of the domain to which the template belongs.
domain-idIntegerNY Y YThe ID of the domain to which the template belongs.
domainStringYY N NThe domain to which the template belongs.

Hyperlink Template: /api/space/domain-management/domains/{*ID}.
configurationStringYY N NThe XML configuration for this template

Hyperlink Template: /api/space/config-template-management/config-templates/{*ID}/configuration.
exec-deployStringYY N NDeploy template configuration on a single device or a group of devices

Hyperlink Template: /api/space/config-template-management/config-templates/{*ID}/exec-deploy.
exec-undeployStringYY N NUndeploy template configuration from a single device or a group of devices

Hyperlink Template: /api/space/config-template-management/config-templates/{*ID}/exec-undeploy.
exec-auditStringYY N NAudit 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-associationsStringYY N NDevice associations for this template

Hyperlink Template: /api/space/config-template-management/config-templates/{*ID}/device-associations.
exec-publishStringYY N NPublish template to device configuration

Hyperlink Template: /api/space/config-template-management/config-templates/{*ID}/exec-publish.
versionsStringYY N NSee all versions of the template.

Hyperlink Template: /api/space/config-template-management/config-templates/{*ID}/versions.

config-template.configTemplateDefInfo

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 NameTypeRead OnlyGETPUT / POSTDescription
@hrefString(URI)NY Y * Link to an external configTemplateDefInfo. Here, href points to the configTemplateDefInfo in the primary configTemplateDefInfo collection.

Hyperlink Template: /api/space/config-template-management/config-template-definitions/{*ID}.
@uriString(URI)YY N Link to this configTemplateDefInfo node in the current node context. This link can be used to retrieve or operate on the currently referenced configTemplateDefInfo in the tree path.

Hyperlink Template: /api/space/config-template-management/config-templates/{*ID}.
idIntegerYY N The ID for the configuration template definition.
nameStringYY N The name of the configuration template definition.
configurationStringYY N The XML configuration for this template definition

Hyperlink Template: /api/space/config-template-management/config-template-definitions/{*ID}/configuration.

config-template (vnd.net.juniper.space.config-template-management.config-template;version=3)

Template Version details with possible operations

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)NY Y Link to this config-template node in the current node context. For primary collection members, href and uri are always the same.

Hyperlink Template: /api/space/config-template-management/config-templates/{*ID}.
@hrefString(URI)YY N Link to an external config-template. Here, href points to the config-template in the primary config-template-versions collection.

Hyperlink Template: /api/space/config-template-management/config-templates/{*ID}.
*idIntegerYY N ConfigTemplateInfo ID.
nameStringNY Y * ConfigTemplateInfo Name.
descriptionStringNY Y * Description.
deployed-tempalte-verIntegerNY Y * Deployed Tempalte Ver.
versionsconfig-template.versionsYY N  
config-typeenum(config-type)YY N Config Type.

Possible Values:
CONFIG_TEMPLATEConfig Template
CONFIG_TEMPLATE_DEFINITION 
APP_SETTINGS 
SERVICE_TEMPLATE_DEFINITION 
CONFIG_EDITOR 
TA_TEMPLATE_DEFINITION 
SERVICE_TEMPLATE 
MONITOR_DEVICE 
API_TEMPLATE_DEFINITION 
QUICK_TEMPLATEQuick Template
.
stateStringYY N State.
os-versionStringYY N Os Version.
current-versionIntegerYY N Current Version.
device-familyStringYY N Device Family.
last-updated-byStringYY N Last Updated By.
last-update-time-stringStringYY N Last Update Time String.
template-deployment-statusStringYY N Template Deployment Status.
config-template-definitionconfig-template.configTemplateDefInfoNY Y Template Version details with possible operations.
domain-nameStringNY Y Domain Name.
domain-idIntegerNY Y Domain ID.
domainStringYY N The domain to which the template belongs.

Hyperlink Template: /api/space/domain-management/domains/{*ID}.
configurationStringYY N The XML configuration for this template

Hyperlink Template: /api/space/config-template-management/config-templates/{*ID}/configuration.
exec-deployStringYY 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-undeployStringYY 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-auditStringYY 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-associationsStringYY N Device associations for this template

Hyperlink Template: /api/space/config-template-management/config-templates/{*ID}/device-associations.
exec-publishStringYY N Publish template to device configuration

Hyperlink Template: /api/space/config-template-management/config-templates/{*ID}/exec-publish.
versionsStringYY N See all versions of the template.

Hyperlink Template: /api/space/config-template-management/config-templates/{*ID}/versions.
cloneStringYY N Clone template from Id

Hyperlink Template: /api/space/config-template-management/config-templates/{*ID}/clone.

config-template.versions

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this versions node in the current node context. This link can be used to retrieve or operate on the currently referenced versions in the tree path.
@totalIntegerYY N Total number of gen_config-template-versions in the API result set. If paging parameters are used in the query to limit the result set size, then total represents the total number of gen_config-template-versions in all the pages of the result set.
versionInteger[]NY Y * Versions.

config-template.configTemplateDefInfo

Template Version details with possible operations

Field NameTypeRead OnlyGETPUT / POSTDescription
@hrefString(URI)NY Y * Link to an external configTemplateDefInfo. Here, href points to the configTemplateDefInfo in the primary configTemplateDefInfo collection.

Hyperlink Template: /api/space/config-template-management/config-template-definitions/{*ID}.
@uriString(URI)YY N Link to this configTemplateDefInfo node in the current node context. This link can be used to retrieve or operate on the currently referenced configTemplateDefInfo in the tree path.

Hyperlink Template: /api/space/config-template-management/config-templates/{*ID}.
idIntegerYY N ConfigTemplateDefInfo ID.
nameStringYY N ConfigTemplateDefInfo Name.
configurationStringYY N The XML configuration for this template definition

Hyperlink Template: /api/space/config-template-management/config-template-definitions/{*ID}/configuration.

Config-template_patch (vnd.net.juniper.space.config-template-management.config-template_patch;version=1)

config-template-definition (vnd.net.juniper.space.config-template-management.config-template-definition;version=1)

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 NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)NY Y Link to this config-template-definition node in the current node context. This link can be used to retrieve or operate on the currently referenced config-template-definition in the tree path.

Hyperlink Template: /api/space/config-template-management/config-template-definitions/{*ID}.
@hrefString(URI)YY N Link to an external config-template-definition. Here, href points to the config-template-definition in the primary config-template-definition collection.

Hyperlink Template: /api/space/config-template-management/config-template-definitions/{*ID}.
*idIntegerYY N The ID for the configuration template definition.
nameStringYY N The name of the configuration template definition.
descriptionStringYY N A description for this configuration template definition.
versionsconfig-template-definition.versionsNY Y * The device versions to which the template can be deployed.
stateStringYY N The state of this configuration template definition. Possible Values: Published, Unpublished.
publishedBooleanYY N A flag that indicates whether this configuration template definition was published.
os-versionStringYY N The Junos OS version for this configuration template definition.
current-versionIntegerYY N The current version of this configuration template definition. The version number is incremented when the configuration template definition is modified.
device-familyStringYY N The Junos device family for this configuration template definition.
last-updated-byStringYY N The user who last updated this configuration template definition.
last-update-timeStringYY N The date and time when this configuration template definition was last modified.
config-templatesconfig-template-definition.configTemplatesYY N A list of configuration templates for this configuration template definition.
domain-nameStringNY Y * The name of the domain to which the template belongs.
domain-idIntegerNY Y * The ID of the domain to which the template belongs.
domainStringYY N The domain to which the template belongs.

Hyperlink Template: /api/space/domain-management/domains/{*ID}.
configurationStringYY N The XML configuration for this template definition

Hyperlink Template: /api/space/config-template-management/config-template-definitions/{*ID}/configuration.

config-template-definition.versions

The device versions to which the template can be deployed.

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this versions node in the current node context. This link can be used to retrieve or operate on the currently referenced versions in the tree path.
versionInteger[]NY Y * The device version.

config-template-definition.configTemplates

A list of configuration templates for this configuration template definition.

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)NY Y Link to this configTemplates node in the current node context. This link can be used to retrieve or operate on the currently referenced configTemplates in the tree path.

Hyperlink Template: /api/space/config-template-management/config-template-definitions/{*ID}/config-templates.
config-templateconfig-template-definition.configTemplates.configTemplateInfo[]NY Y * A configuration template represents a partial configuration that can be deployed or published to a single device or group of devices.

config-template-definition.configTemplates.configTemplateInfo

A configuration template represents a partial configuration that can be deployed or published to a single device or group of devices.

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@hrefString(URI)NY Y * NNLink to an external configTemplateInfo. Here, href points to the configTemplateInfo in the primary configTemplateInfo collection.

Hyperlink Template: /api/space/config-template-management/config-templates/{*ID}.
@uriString(URI)YY N NNLink to this configTemplateInfo node in the current node context. This link can be used to retrieve or operate on the currently referenced configTemplateInfo in the tree path.

Hyperlink Template: /api/space/config-template-management/config-template-definitions/{*ID}/config-templates/{*ID}.
idIntegerYY N NNThe ID of the configuration template.
nameStringYY N NNThe name of the configuration template.

config-template-definitions (vnd.net.juniper.space.config-template-management.config-template-definitions;version=1)

A list of configuration template definitions.

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)NY Y Link to this config-template-definitions node in the current node context. This link can be used to retrieve or operate on the currently referenced config-template-definitions in the tree path.
@totalIntegerYY N Total number of config-template-definitions in the API result set. If paging parameters are used in the query to limit the result set size, then total represents the total number of config-template-definitions in all the pages of the result set.
config-template-definitionconfig-template-definitions.configTemplateDefInfo[]NY 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.

config-template-definitions.configTemplateDefInfo

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 NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)NY Y NNLink to this configTemplateDefInfo node in the current node context. This link can be used to retrieve or operate on the currently referenced configTemplateDefInfo in the tree path.

Hyperlink Template: /api/space/config-template-management/config-template-definitions/{*ID}.
@hrefString(URI)YY N NNLink to an external configTemplateDefInfo. Here, href points to the configTemplateDefInfo in the primary configTemplateDefInfo collection.

Hyperlink Template: /api/space/config-template-management/config-template-definitions/{*ID}.
idIntegerYY N YYThe ID for the configuration template definition.
nameStringYY N YYThe name of the configuration template definition.
descriptionStringYY N YYA description for this configuration template definition.
stateStringYY N NNThe state of this configuration template definition. Possible Values: Published, Unpublished.
publishedBooleanYY N NNA flag that indicates whether this configuration template definition was published.
current-versionIntegerYY N NNThe current version of this configuration template definition. The version number is incremented when the configuration template definition is modified.
device-familyStringYY N NNThe Junos device family for this configuration template definition.
last-updated-byStringYY N YYThe user who last updated this configuration template definition.
last-update-timeStringYY N YYThe date and time when this configuration template definition was last modified.

config-template-details (vnd.net.juniper.space.config-template-management.config-template-details;version=3)

Template Version details with possible operations

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this config-template-details node in the current node context. This link can be used to retrieve or operate on the currently referenced config-template-details in the tree path.

Hyperlink Template: /api/space/config-template-management/config-templates/{*ID}/versions/{*ID}.
@hrefString(URI)YY N Link to an external config-template. Here, href points to the config-template in the primary config-template-versions collection.

Hyperlink Template: /api/space/config-template-management/config-templates/{*ID}/versions/{*ID}.
*idIntegerYY N ConfigTemplateInfo ID.
nameStringNY Y * ConfigTemplateInfo Name.
descriptionStringNY Y * Description.
domain-idIntegerNY Y Domain ID.
domain-nameStringNY Y Domain Name.
versionsconfig-template-details.versionsYY N  
deployed-tempalte-verIntegerNY Y * Deployed Tempalte Ver.
stateStringYY N State.
config-template-definitionconfig-template-details.configTemplateDefInfoNY Y Template Version details with possible operations.
last-update-timeLongYY N Last Update Time.
last-updated-byStringYY N Last Updated By.
last-update-time-stringStringYY N Last Update Time String.
template-deployment-statusStringYY N Template Deployment Status.
current-versionIntegerYY N Current Version.
schema-idStringYY N Schema ID.
device-familyStringYY N Device Family.
os-versionStringYY N Os Version.
configurationStringYY N The XML configuration for this template version

Hyperlink Template: /api/space/config-template-management/config-templates/{*ID}/versions/{*ID}/configuration.
exec-deployStringYY 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-associationsStringYY N Device associations for this template version

Hyperlink Template: /api/space/config-template-management/config-templates/{*ID}/versions/{*ID}/device-associations.
exec-publishStringYY N Publish template version to device configuration

Hyperlink Template: /api/space/config-template-management/config-templates/{*ID}/versions/{*ID}/exec-publish.
exec-auditTemplateStringYY N Audit template version

Hyperlink Template: /api/space/config-template-management/config-templates/{*ID}/versions/{*ID}/exec-auditTemplate.
exec-compareConfigStringYY N compare config

Hyperlink Template: /api/space/config-template-management/config-templates/{*ID}/versions/{*ID}/exec-compareConfig.

config-template-details.versions

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this versions node in the current node context. This link can be used to retrieve or operate on the currently referenced versions in the tree path.
@totalIntegerYY N Total number of gen_config-template-details-versions in the API result set. If paging parameters are used in the query to limit the result set size, then total represents the total number of gen_config-template-details-versions in all the pages of the result set.
versionInteger[]NY Y * Versions.

config-template-details.configTemplateDefInfo

Template Version details with possible operations

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this configTemplateDefInfo node in the current node context. This link can be used to retrieve or operate on the currently referenced configTemplateDefInfo in the tree path.

Hyperlink Template: /api/space/config-template-management/config-templates/{*ID}/versions/{*ID}.
@hrefString(URI)NY Y * Link to an external configTemplateDefInfo. Here, href points to the configTemplateDefInfo in the primary configTemplateDefInfo collection.

Hyperlink Template: /api/space/config-template-management/config-template-definitions/{*ID}.
idIntegerYY N ConfigTemplateDefInfo ID.
nameStringYY N ConfigTemplateDefInfo Name.

config-template-no-definition (vnd.net.juniper.space.config-template-management.config-template-no-definition;version=1)

A configuration template represents a partial configuration that can be deployed or published to a single device or group of devices.

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this config-template-no-definition node in the current node context. This link can be used to retrieve or operate on the currently referenced config-template-no-definition in the tree path.

Hyperlink Template: /api/space/config-template-management/config-templates/{*ID}.
@hrefString(URI)YY N Link to an external config-template-no-definition. Here, href points to the config-template-no-definition in the primary config-template-no-definition collection.

Hyperlink Template: /api/space/config-template-management/config-templates/{*ID}.
last-update-timeLongYY N The date and time that the configuration template was last modified.
domain-idIntegerNY Y The ID of the domain to which the template belongs.
descriptionStringNY Y * A description of the configuration template.
last-update-time-stringStringYY N The date and time that the configuration template was last modified.
idIntegerYY N The ID of the configuration template.
stateStringYY N The state of the configuration template. Possible Values: enabled, disabled, need-review.
nameStringNY Y * The name of the configuration template.
current-versionIntegerYY N The current version of the configuration template. The version number is incremented when the template is modified.
last-updated-byStringYY N The user who last updated this configuration template.
domain-nameStringNY Y The name of the domain to which the template belongs.
device-familyStringNY Y * The Junos Device family for the configuration template.
os-versionStringNY Y The Junos OS version for the configuration template.
config-typeenum(config-type)YY N The configuration type for the configuration template.

Possible Values:
CONFIG_TEMPLATEConfig Template
CONFIG_TEMPLATE_DEFINITION 
APP_SETTINGS 
SERVICE_TEMPLATE_DEFINITION 
CONFIG_EDITOR 
TA_TEMPLATE_DEFINITION 
SERVICE_TEMPLATE 
MONITOR_DEVICE 
API_TEMPLATE_DEFINITION 
QUICK_TEMPLATEQuick Template
.

config-template-ref (vnd.net.juniper.space.config-template-management.config-template-ref;version=1)

A configuration template represents a partial configuration that can be deployed or published to a single device or group of devices.

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this config-template-ref node in the current node context. This link can be used to retrieve or operate on the currently referenced config-template-ref in the tree path.

Hyperlink Template: /api/space/config-template-management/config-template-definitions/{*ID}/config-templates/{*ID}.
@hrefString(URI)NY Y * Link to an external config-template-ref. Here, href points to the config-template-ref in the primary config-template-ref collection.

Hyperlink Template: /api/space/config-template-management/config-templates/{*ID}.
domain-idIntegerYY N The ID of the domain to which the template belongs.
*idIntegerYY N The ID of the configuration template.
nameStringYY N The name of the configuration template.
domain-nameStringYY N The name of the domain to which the template belongs.

config-template-refs (vnd.net.juniper.space.config-template-management.config-template-refs;version=1)

A collection of references to configuration templates.

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)NY Y Link to this config-template-refs node in the current node context. This link can be used to retrieve or operate on the currently referenced config-template-refs in the tree path.

Hyperlink Template: /api/space/config-template-management/config-template-definitions/{*ID}/config -templates.
@totalIntegerYY N Total number of config-templates in the API result set. If paging parameters are used in the query to limit the result set size, then total represents the total number of config-templates in all the pages of the result set.
config-templateconfig-template-refs.configTemplateInfo[]NY Y * A configuration template represents a partial configuration that can be deployed or published to a single device or group of devices.

config-template-refs.configTemplateInfo

A configuration template represents a partial configuration that can be deployed or published to a single device or group of devices.

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@hrefString(URI)NY Y * NNLink to an external configTemplateInfo. Here, href points to the configTemplateInfo in the primary configTemplateInfo collection.

Hyperlink Template: /api/space/config-template-management/config-templates/{*ID}.
@uriString(URI)YY N NNLink to this configTemplateInfo node in the current node context. This link can be used to retrieve or operate on the currently referenced configTemplateInfo in the tree path.

Hyperlink Template: /api/space/config-template-management/config-template-definitions/{*ID}/config-templates/{*ID}.
idIntegerYY N NNThe ID of the configuration template.
nameStringYY N NNThe name of the configuration template.

config-templates (vnd.net.juniper.space.config-template-management.config-templates;version=1)

A list of configuration templates.

Field NameTypeRead OnlyGETPUT / POSTPATCHDescription
@uriString(URI)NY Y NLink to this config-templates node in the current node context. This link can be used to retrieve or operate on the currently referenced config-templates in the tree path.
@totalIntegerYY N NTotal number of config-templates in the API result set. If paging parameters are used in the query to limit the result set size, then total represents the total number of config-templates in all the pages of the result set.
config-templateconfig-templates.configTemplateInfo[]NY Y * YA configuration template represents a partial configuration that can be deployed or published to a single device or group of devices.

config-templates.configTemplateInfo

A configuration template represents a partial configuration that can be deployed or published to a single device or group of devices.

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)NY Y NNLink to this configTemplateInfo node in the current node context. This link can be used to retrieve or operate on the currently referenced configTemplateInfo in the tree path.

Hyperlink Template: /api/space/config-template-management/config-templates/{*ID}.
@hrefString(URI)YY N NNLink to an external configTemplateInfo. Here, href points to the configTemplateInfo in the primary configTemplateInfo collection.

Hyperlink Template: /api/space/config-template-management/config-templates/{*ID}.
idIntegerYY N YYThe ID of the configuration template.
nameStringNY Y * YYThe name of the configuration template.
descriptionStringNY Y * YYA description of the configuration template.
config-typeenum(config-type)YY N YYThe configuration type for the configuration template.

Possible Values:
CONFIG_TEMPLATEConfig Template
CONFIG_TEMPLATE_DEFINITION 
APP_SETTINGS 
SERVICE_TEMPLATE_DEFINITION 
CONFIG_EDITOR 
TA_TEMPLATE_DEFINITION 
SERVICE_TEMPLATE 
MONITOR_DEVICE 
API_TEMPLATE_DEFINITION 
QUICK_TEMPLATEQuick Template
.
stateStringYY N NNThe state of the configuration template. Possible Values: enabled, disabled, need-review.
os-versionStringYY N YNThe Junos OS version for the configuration template.
current-versionIntegerYY N NNThe current version of the configuration template. The version number is incremented when the template is modified.
device-familyStringYY N YNThe Junos Device family for the configuration template.
last-updated-byStringYY N YYThe user who last updated this configuration template.
last-update-time-stringStringYY N YYThe date and time that the configuration template was last modified.
domain-nameStringNY Y NNThe name of the domain to which the template belongs.
domain-idIntegerNY Y NNThe ID of the domain to which the template belongs.

Config-templates_patch (vnd.net.juniper.space.config-template-management.config-templates_patch;version=1)

config-templates-by-id2-request (vnd.net.juniper.space.config-template-management.config-templates-by-id2-request;version=3)

Field NameTypeRead OnlyGETPUT / POSTDescription
template-id-listconfig-templates-by-id2-request.templateIdListsNY Y *  

config-templates-by-id2-request.templateIdLists

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this templateIdLists node in the current node context. This link can be used to retrieve or operate on the currently referenced templateIdLists in the tree path.
template-id-listInteger[]NY Y * Template ID Lists.

config-templates-by-ids2 (vnd.net.juniper.space.config-template-management.config-templates-by-ids2;version=3)

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this config-templates-by-ids2 node in the current node context. This link can be used to retrieve or operate on the currently referenced config-templates-by-ids2 in the tree path.
@totalIntegerYY N Total number of config-templates-by-ids2 in the API result set. If paging parameters are used in the query to limit the result set size, then total represents the total number of config-templates-by-ids2 in all the pages of the result set.
versionconfig-templates-by-ids2.version[]NY Y *  

config-templates-by-ids2.version

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)YY N NNLink to this version node in the current node context. This link can be used to retrieve or operate on the currently referenced version in the tree path.
contentStringNY Y * NNContent.
deploy-statusStringNY Y * NNDeploy Status.
template-idStringYY N NNTemplate ID.
modified-timeDateNY Y * NNModified Time.
numberStringNY Y * NNNumber.

config-template-versions (vnd.net.juniper.space.config-template-management.config-template-versions;version=3)

Collection of all the versions of the template with a brief description.

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this config-template-versions node in the current node context. This link can be used to retrieve or operate on the currently referenced config-template-versions in the tree path.
@totalIntegerYY N Total number of config-template-versions in the API result set. If paging parameters are used in the query to limit the result set size, then total represents the total number of config-template-versions in all the pages of the result set.
config-templateconfig-template-versions.configTemplateInfo[]NY Y * Template Version details with possible operations.

config-template-versions.configTemplateInfo

Template Version details with possible operations

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)YY N NNLink to this configTemplateInfo node in the current node context. This link can be used to retrieve or operate on the currently referenced configTemplateInfo in the tree path.

Hyperlink Template: /api/space/config-template-management/config-templates/{*ID}/versions/{*ID}.
@hrefString(URI)YY N NNLink to an external config-template. Here, href points to the config-template in the primary config-template-versions collection.

Hyperlink Template: /api/space/config-template-management/config-templates/{*ID}/versions/{*ID}.
descriptionStringNY Y * YYDescription.
last-update-time-stringStringYY N YYLast Update Time String.
template-deployment-statusStringYY N NNTemplate Deployment Status.
last-update-timeLongYY N NNLast Update Time.
idIntegerYY N YYConfigTemplateInfo ID.
nameStringNY Y * YYConfigTemplateInfo Name.
current-versionIntegerYY N YYCurrent Version.
device-familyStringYY N NNDevice Family.
os-versionStringYY N YNOs Version.
config-typeenum(config-type)YY N YYConfig Type.

Possible Values:
CONFIG_TEMPLATEConfig Template
CONFIG_TEMPLATE_DEFINITION 
APP_SETTINGS 
SERVICE_TEMPLATE_DEFINITION 
CONFIG_EDITOR 
TA_TEMPLATE_DEFINITION 
SERVICE_TEMPLATE 
MONITOR_DEVICE 
API_TEMPLATE_DEFINITION 
QUICK_TEMPLATEQuick Template
.

configuration (vnd.net.juniper.space.config-template-management.configuration;version=1)

The data for a configuration is contained in an XML configuration document.

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)NY Y Link to this configuration node in the current node context. This link can be used to retrieve or operate on the currently referenced configuration in the tree path.

Hyperlink Template: /api/space/config-template-management/config-templates/{*ID}/configuration.
@hrefString(URI)YY N Link to an external configuration. Here, href points to the configuration in the primary configuration collection.

Hyperlink Template: /api/space/config-template-management/config-templates/{*ID}/configuration.
dataStringNY Y * The XML configuration document.

configuration-all (vnd.net.juniper.space.config-template-management.configuration-all;version=2)

The configuration returned in CLI set format and XML format.

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this configuration-all node in the current node context. This link can be used to retrieve or operate on the currently referenced configuration-all in the tree path.

Hyperlink Template: /api/space/config-template-management/templates/{*ID}/quick-template- config.
cliStringNY Y * The content of the configuration template in CLI format.
xmlStringNY Y * The content of the configuration template in XML format.

configuration-cli (vnd.net.juniper.space.config-template-management.configuration-cli;version=2)

The configuration returned in CLI set format.

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this configuration-cli node in the current node context. This link can be used to retrieve or operate on the currently referenced configuration-cli in the tree path.

Hyperlink Template: /api/space/config-template-management/templates/{*ID}/quick-template- config.
cliStringNY Y * The content of the configuration template in CLI format.

configuration-cli-request (vnd.net.juniper.space.config-template-management.configuration-cli-request;version=2)

The configuration template in CLI format.

Field NameTypeRead OnlyGETPUT / POSTDescription
clisStringNY Y * Clis.

configurations (vnd.net.juniper.space.device-management.configurations;version=1)

The 'configurations' resource model represents a view of information about access configuration options of a device. It consists of the following pull-through fields:

Field NameTypeRead OnlyGETPUT / POSTDescription
@hrefString(URI)NY Y Link to an external configurations. Here, href points to the configurations in the primary configurations collection.
idIntegerNY Y A unique ID for the 'configurations' resource.
expanded-configurationStringNY Y Location of the 'expanded-configuration' resource.
raw-configurationStringNY Y Location of the 'raw-configuration' resource.

configuration-update-result (vnd.net.juniper.space.config-template-management.configuration-update-result;version=2)

The results from an update of a configuration template on a device, indicating whether the update succeeded. If a validation error occurs, the reason and line number where the error occurred is returned.

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this configuration-update-result node in the current node context. This link can be used to retrieve or operate on the currently referenced configuration-update-result in the tree path.
err-messageStringNY Y A description of the error.
errorsconfiguration-update-result.errorsNY Y A list of any errors in the content of the configuration template.
statusStringNY Y * The status of the update. The status returned is either OK or Failed.
variable-existingBooleanNY Y * Indicates whether the template contains a variable.

configuration-update-result.errors

A list of any errors in the content of the configuration template.

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this errors node in the current node context. This link can be used to retrieve or operate on the currently referenced errors in the tree path.
validation-errorconfiguration-update-result.errors.quickTemplateValidationError[]NY Y * A list of validation errors.

configuration-update-result.errors.quickTemplateValidationError

A list of validation errors.

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)YY N NNLink to this quickTemplateValidationError node in the current node context. This link can be used to retrieve or operate on the currently referenced quickTemplateValidationError in the tree path.
err-reasonStringNY Y * NNThe reason the CLI failed validation.
line-numberIntegerNY Y * NNThe line number in content of the configuration template where the error occurred.

configuration-view (vnd.net.juniper.space.configuration-management.configuration-view;version=2)

Configuration view details
Configuration Views are configuration tools that enables the user who wants to see configuration details in his/her own way

Field NameTypeRead OnlyGETPUT / POSTPATCHDescription
@uriString(URI)YY N NLink to this configuration-view node in the current node context. This link can be used to retrieve or operate on the currently referenced configuration-view in the tree path.

Hyperlink Template: /api/space/configuration-management/configuration-views/{*ID}.
@hrefString(URI)YY N NLink to an external configuration-view. Here, href points to the configuration-view in the primary configuration-view collection.

Hyperlink Template: /api/space/configuration-management/configuration-views/{*ID}.
*idIntegerYY N NConfiguration View ID
Unique key for the configuration view.
nameStringNY Y * YConfiguration View Name
The Name of the configuration view and it cannot exceed 255 characters. Allowable characters include the dash (-), underscore (_), letters, and numbers and the period (.).
You cannot have two configuration views with the same name.
domain-idIntegerYY N NDomain ID
It specifies the domain ID for which this configlet belongs to.
domain-nameStringYY N NDomain Name
Name of the domain for which the configlet belongs to.
view-typeenum(view-type)NY Y YView Type
There are four types of view types
TypeParameter Scope
FORMVIEW Form View is simple view of configuration as key value pair. The dynamic fields in form view are defined using parameters.
GRIDVIEW Grid view is a customizable grid that can show key(column) list of values(rows) pair.
XMLVIEW XML view shows the configuration XML of the selected component.
CLIVIEW CLI view shows the configuration CLI of the selected component.
.

Possible Values:
CLIVIEWCLI View
FORMVIEWForm View
GRIDVIEWGrid View
XMLVIEWXML View

Default: FORMVIEW.
titleStringNY Y * YTitle
The title of the configuration view and it cannot exceed 255 characters. Allowable characters include the dash (-), underscore (_), letters, and numbers and the period (.).
device-familyStringNY Y * YDevice Family
The device family for which the configuration view will be applicable for.
contextStringNY Y YContext
The context for which the configuration view would be applicable for.
i.e., Configuration view could be restricted to be accessible only on specific elements(devices, physical interfaces). So that it would not be applicable/visible to other elements.
descriptionStringNY Y YDescription
The description of the configuration view and it cannot exceed 2500 characters.
orderIntegerNY Y * YOrder
Order of the configuration view tab in Device Configuration View UI. That is based on this value configuration view tab will be added in given order.

Min: 1 Max: 65535.
creation-timeDateYY N NCreation 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-timeDateYY N NLast 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-byStringYY N NLast Modified user
The name of the user who modified the configuration view at last.
configuration-view-paramsconfiguration-view.configViewerParamsNY Y * YList of configuration view parameters.

configuration-view.configViewerParams

List of configuration view parameters

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this configViewerParams node in the current node context. This link can be used to retrieve or operate on the currently referenced configViewerParams in the tree path.

Hyperlink Template: /api/space/configuration-management/configuration-views/{*ID}/configuration-view-params.
configuration-view-paramconfiguration-view.configViewerParams.configViewerParam[]NY Y * Configuration view parameter
Parameters are the variables defined in the configuration view whose values are got from the environment.

configuration-view.configViewerParams.configViewerParam

Configuration view parameter
Parameters are the variables defined in the configuration view whose values are got from the environment

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)YY N NNLink to this configViewerParam node in the current node context. This link can be used to retrieve or operate on the currently referenced configViewerParam in the tree path.
idIntegerYY N NNConfiguration View Parameter ID
Unique ID for the configuration view parameter.
parameterStringNY Y * NNParameter 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-parameterBooleanNY Y NNIndex 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-nameStringNY Y * NNDisplay 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-dependentBooleanNY Y NNScript Dependent
Setting this option to true enables to refer a local script. That is the configuration view is dependent on that local script

Setting this option as true will disable Index Parameter and Customized Attribute fields
Default = false.
local-script-nameStringNY Y NNLocal 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.
customizedBooleanNY Y NNCustomized 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.
editableBooleanNY Y NNEditable
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-xpathStringNY Y * NNConfigured Value Xpath
This field is used to give the Xpath of the configured values. The behavior of this field depends on the type of view.
When the view type is FORMVIEW, the corresponding value present in the Xpath is taken as the field value. In case Xpath returns multiple values, first value returned is considered. In case the Xpath returns multiple values, the first value returned is considered.

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.
orderIntegerNY Y * NNOrder
The order of the parameter. The relative order in which the parameter has to be displayed.

Min: 1 Max: 65535.

Configuration-view_patch (vnd.net.juniper.space.configuration-management.configuration-view_patch;version=2)

configuration-view-param (vnd.net.juniper.space.configuration-management.configuration-view-param;version=2)

Configuration view parameter
Parameters are the variables defined in the configuration view whose values are got from the environment

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this configuration-view-param node in the current node context. This link can be used to retrieve or operate on the currently referenced configuration-view-param in the tree path.
idIntegerNY Y * Configuration View Parameter ID
Unique ID for the configuration view parameter.
parameterStringNY 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-parameterBooleanNY 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-nameStringNY 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-dependentBooleanNY Y * Script Dependent
Setting this option to true enables to refer a local script. That is the configuration view is dependent on that local script

Setting this option as true will disable Index Parameter and Customized Attribute fields
Default = false.
local-script-nameStringNY 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.
customizedBooleanNY 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.
editableBooleanNY 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-xpathStringNY Y * Configured Value Xpath
This field is used to give the Xpath of the configured values. The behavior of this field depends on the type of view.
When the view type is FORMVIEW, the corresponding value present in the Xpath is taken as the field value. In case Xpath returns multiple values, first value returned is considered. In case the Xpath returns multiple values, the first value returned is considered.

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.
orderIntegerNY Y * Order
The order of the parameter. The relative order in which the parameter has to be displayed.

Min: 1 Max: 65535.

configuration-views (vnd.net.juniper.space.configuration-management.configuration-views;version=2)

List of configuration view

Field NameTypeRead OnlyGETPUT / POSTPATCHDescription
@uriString(URI)YY N NLink to this configuration-views node in the current node context. This link can be used to retrieve or operate on the currently referenced configuration-views in the tree path.
@totalIntegerYY N NTotal number of configuration-views in the API result set. If paging parameters are used in the query to limit the result set size, then total represents the total number of configuration-views in all the pages of the result set.
configuration-viewconfiguration-views.configViewer[]NY Y * YConfiguration view details
Configuration Views are configuration tools that enables the user who wants to see configuration details in his/her own way.

configuration-views.configViewer

Configuration view details
Configuration Views are configuration tools that enables the user who wants to see configuration details in his/her own way

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)YY N NNLink to this configViewer node in the current node context. This link can be used to retrieve or operate on the currently referenced configViewer in the tree path.

Hyperlink Template: /api/space/configuration-management/configuration-views/{*ID}.
@hrefString(URI)YY N NNLink to an external configViewer. Here, href points to the configViewer in the primary configViewer collection.

Hyperlink Template: /api/space/configuration-management/configuration-views/{*ID}.
idIntegerYY N NNConfiguration View ID
Unique key for the configuration view.
nameStringNY Y * YYConfiguration View Name
The Name of the configuration view and it cannot exceed 255 characters. Allowable characters include the dash (-), underscore (_), letters, and numbers and the period (.).
You cannot have two configuration views with the same name.
domain-idIntegerYY N NYDomain ID
It specifies the domain ID for which this configlet belongs to.
domain-nameStringYY N NNDomain Name
Name of the domain for which the configlet belongs to.
titleStringNY Y * YYTitle
The title of the configuration view and it cannot exceed 255 characters. Allowable characters include the dash (-), underscore (_), letters, and numbers and the period (.).
device-familyStringNY Y * YYDevice Family
The device family for which the configuration view will be applicable for.
descriptionStringNY Y NNDescription
The description of the configuration view and it cannot exceed 2500 characters.
view-typeenum(view-type)NY Y YYView Type
There are four types of view types
TypeParameter Scope
FORMVIEW Form View is simple view of configuration as key value pair. The dynamic fields in form view are defined using parameters.
GRIDVIEW Grid view is a customizable grid that can show key(column) list of values(rows) pair. The dynamic column values in grid view are defined using parameter definitions. Velocity templates (VTL) are used to define the parameters.
XMLVIEW XML view shows the configuration XML of the selected component.
CLIVIEW CLI view shows the configuration CLI of the selected component.
.

Possible Values:
CLIVIEWCLI View
FORMVIEWForm View
GRIDVIEWGrid View
XMLVIEWXML View

Default: FORMVIEW.
creation-timeDateYY N YYCreation 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-timeDateYY N YYLast 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-byStringYY N YYLast Modified user
The name of the user who modified the configuration view at last.
orderIntegerNY Y * YYOrder
Order of the configuration view tab in Device Configuration View UI. That is based on this value configuration view tab will be added in given order.

Min: 1 Max: 65535.

Configuration-views_patch (vnd.net.juniper.space.configuration-management.configuration-views_patch;version=2)

configuration-xml (vnd.net.juniper.space.config-template-management.configuration-xml;version=2)

The configuration returned in XML format.

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this configuration-xml node in the current node context. This link can be used to retrieve or operate on the currently referenced configuration-xml in the tree path.

Hyperlink Template: /api/space/config-template-management/templates/{*ID}/quick-template- config.
xmlStringNY Y * The content of the configuration template in XML format.

configuration-xml-request (vnd.net.juniper.space.config-template-management.configuration-xml-request;version=2)

Field NameTypeRead OnlyGETPUT / POSTDescription
xmlStringNY Y * Xml Data.

connection-profile (vnd.net.juniper.space.device-management.modeled-device-management.connection-profile;version=1)

Field NameTypeRead OnlyGETPUT / POSTPATCHDescription
@uriString(URI)YY N NLink to this connection-profile node in the current node context. This link can be used to retrieve or operate on the currently referenced connection-profile in the tree path.

Hyperlink Template: /api/space/device-management/modeled-device-management/connection-profiles/{*ID}.
@hrefString(URI)YY N NLink to an external connection-profile. Here, href points to the connection-profile in the primary connection-profile collection.

Hyperlink Template: /api/space/device-management/modeled-device-management/connection-profiles/{*ID}.
*idIntegerYY N NID of the connection profile.
nameStringNY Y * YName of the connection profile.
descriptionStringNY Y YDescription of connection profile.
interface-typeenum(interface-type)NY Y YType of the interface for which the connection profile is being set. Possible values: ETHERNET, ADSL, T1.

Possible Values:
ETHERNET 
ADSL 
T1 

Default: ETHERNET.
interface-nameStringNY Y YName of the interface for which the connection profile is being set.

Default: "ge-0/0/0".
ip-typeStringNY Y YSystem based parameter- Defines the ip type of connection profile.
use-natBooleanNY Y YIs JNAP server behind NAT [NAT enabled].

Default: false.
typeStringNY Y * YThe Connection type for the profile. The Possible values: DHCP, PPPoA, PPPoE, Static. The values are case sensitive.
dhcp-retransmission-attemptIntegerNY Y YDhcp parameter- Retransmission Attempt.

Min: 1 Max: 6.
dhcp-retransmission-intervalIntegerNY Y YDhcp parameter- Retransmission Interval.

Min: 1 Max: 64.
dhcp-server-addressStringNY Y YDhcp parameter- Server IP address.
dhcp-update-serverBooleanNY Y YDhcp parameter- Update Server.
dhcp-lease-never-expiresBooleanNY Y YDhcp parameter-Lease time never expires.
dhcp-lease-timeIntegerNY Y YDhcp parameter-custom Lease time.

Min: 1 Max: 64.
dhcp-default-leaseBooleanNY Y YDhcp parameter- Lease time set to default.
auth-protocol-typeStringNY Y YAuth Protocol - CHAP/PAP.
user-nameStringNY Y YThe CHAP username.Username to authenticate with the device.
passwordStringNY Y YThe CHAP password.Password to authenticate with the device.
access-profile-user-nameStringNY Y YAccess profile username.Used in PPP link establishment.
access-profile-passwordStringNY Y YAccess profile password.Used in PPP link establishment.
vpiIntegerNY Y YThe VPI(Virtual Path Identifier) in case of ADSL(ie PPPoA), values are changed based on ISPs.

Min: 0 Max: 6000.
vciIntegerNY Y YThe VCI(Virtual Channel Identifier) in case of ADSL(ie PPPoA), values are changed based on ISPs.

Min: 0 Max: 6000.
encapsulation-typeStringNY Y YEncapsulation Type for ADSL(ie PPPoA) - values atm-ppp-vc-mux & atm-ppp-llc.
concentrator-nameStringNY Y YConcentrator name for PPPoE.
service-nameStringNY Y YService name.
time-intervalIntegerNY Y YPPPoE parameter-auto connect time interval.

Min: 0 Max: 6000.
idle-periodIntegerNY Y YPPPoE parameter-ideal time before disconnect.

Min: 0 Max: 6000.

Connection-profile_patch (vnd.net.juniper.space.device-management.modeled-device-management.connection-profile_patch;version=1)

connection-profiles (vnd.net.juniper.space.device-management.modeled-device-management.connection-profiles;version=1)

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this connection-profiles node in the current node context. This link can be used to retrieve or operate on the currently referenced connection-profiles in the tree path.
@totalIntegerYY N Total number of connection-profiles in the API result set. If paging parameters are used in the query to limit the result set size, then total represents the total number of connection-profiles in all the pages of the result set.
connection-profileconnection-profiles.connectionProfileMOREST[]NY Y * Connection-profile which Contains connection-establishment parameters like ip details, NAT details, connection-type(DHCP,ADSL,PPPoaA,PPPoE) and its sub-parameters.

connection-profiles.connectionProfileMOREST

Connection-profile which Contains connection-establishment parameters like ip details, NAT details, connection-type(DHCP,ADSL,PPPoaA,PPPoE) and its sub-parameters

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)YY N NNLink to this connectionProfileMOREST node in the current node context. This link can be used to retrieve or operate on the currently referenced connectionProfileMOREST in the tree path.

Hyperlink Template: /api/space/device-management/modeled-device-management/connection-profiles/{*ID}.
@hrefString(URI)YY N NNLink to an external connectionProfileMOREST. Here, href points to the connectionProfileMOREST in the primary connectionProfileMOREST collection.

Hyperlink Template: /api/space/device-management/modeled-device-management/connection-profiles/{*ID}.
idIntegerYY N NNID of the connection profile.
nameStringNY Y NNName of the connection profile.
typeStringNY Y * NNThe Connection type (for example; DHCP, PPPoA, PPPoE, Static).
descriptionStringNY Y NNDescription of connection profile.

connection-status (vnd.net.juniper.space.device-management.connection-status;version=1)

The 'connection-status' resource model represents a view of the information about the connection status of the device. It consists of the following fields:

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)NY Y Link to this connection-status node in the current node context. This link can be used to retrieve or operate on the currently referenced connection-status in the tree path.
statusStringNY Y Connection status of the device.

create-connection-profile-dhcp-request (vnd.net.juniper.space.device-management.modeled-device-management.create-connection-profile-dhcp-request;version=1)

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this create-connection-profile-dhcp-request node in the current node context. This link can be used to retrieve or operate on the currently referenced create-connection-profile-dhcp-request in the tree path.
idIntegerYY N ID of the connection profile.
nameStringNY Y * Name of the connection profile.
descriptionStringNY Y Description of the connection profile.
interface-typeenum(interface-type)NY Y Type of the interface for which the connection profile is being set. Possible values: ETHERNET,ADSL,T1.

Possible Values:
ETHERNET 
ADSL 
T1 

Default: ETHERNET.
interface-nameStringNY Y Name of the interface for which the connection profile is being set.

Default: "ge-0/0/0".
ip-typeStringNY Y System based parameter- Defines the ip type of connection profile.
use-natBooleanNY Y Is JNAP server behind NAT [NAT enabled].

Default: false.
dhcp-retransmission-attemptIntegerNY Y Dhcp parameter- Retransmission Attempt.

Default: 4 Min: 1 Max: 6.
dhcp-retransmission-intervalIntegerNY Y Dhcp parameter- Retransmission Interval.

Default: 4 Min: 1 Max: 64.
dhcp-server-addressStringNY Y Dhcp parameter- Server IP address.
dhcp-update-serverBooleanNY Y Dhcp parameter- Update Server.
dhcp-default-leaseBooleanNY Y Dhcp parameter- Lease time set to default.
dhcp-lease-never-expiresBooleanNY Y Dhcp parameter-Lease time never expires.
dhcp-lease-timeIntegerNY Y Dhcp parameter-custom Lease time.

Min: 1 Max: 64.

create-connection-profile-dhcp-response (vnd.net.juniper.space.device-management.modeled-device-management.create-connection-profile-dhcp-response;version=1)

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this create-connection-profile-dhcp-response node in the current node context. This link can be used to retrieve or operate on the currently referenced create-connection-profile-dhcp-response in the tree path.
connection-profilecreate-connection-profile-dhcp-response.connectionProfileMORESTNY Y * Connection profile details.

create-connection-profile-dhcp-response.connectionProfileMOREST

Connection profile details

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this connectionProfileMOREST node in the current node context. This link can be used to retrieve or operate on the currently referenced connectionProfileMOREST in the tree path.

Hyperlink Template: /api/space/device-management/modeled-device-management/connection-profiles/{*ID}.
@hrefString(URI)NY Y * Link to an external connectionProfileMOREST. Here, href points to the connectionProfileMOREST in the primary connectionProfileMOREST collection.

Hyperlink Template: /api/space/device-management/modeled-device-management/connection-profiles/{*ID}.
idIntegerYY N ID of the connection profile.
nameStringYY N Name of the connection profile.

create-connection-profile-pppoa-request (vnd.net.juniper.space.device-management.modeled-device-management.create-connection-profile-pppoa-request;version=1)

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this create-connection-profile-pppoa-request node in the current node context. This link can be used to retrieve or operate on the currently referenced create-connection-profile-pppoa-request in the tree path.
idIntegerYY N ID of the connection profile.
nameStringNY Y * Name of the connection profile.
descriptionStringNY Y Description of the connection profile.
interface-typeenum(interface-type)NY Y Type of the interface for which the connection profile is being set. Possible values: ADSL.

Possible Values:
ETHERNET 
ADSL 
T1 

Default: ADSL.
interface-nameStringNY Y Name of the interface for which the connection profile is being set.

Default: "at-1/0/0".
ip-typeStringNY Y System based parameter- Defines the ip type of connection profile.
use-natBooleanNY Y Is JNAP server behind NAT [NAT enabled].

Default: false.
auth-protocol-typeStringNY Y Auth Protocol CHAP or PAP.

Default: "CHAP".
user-nameStringNY Y * The CHAP username.Username to authenticate with the device.
passwordStringNY Y * The CHAP password.
access-profile-user-nameStringNY Y Access profile username.
access-profile-passwordStringNY Y Access profile password.
vpiIntegerNY Y The VPI(Virtual Path Identifier) in case of ADSL(ie PPPoA), values are changed based on ISPs.

Default: 1 Min: 0 Max: 6000.
vciIntegerNY 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-typeStringNY Y Encapsulation Type for ADSL(ie PPPoA) - values atm-ppp-vc-mux & atm-ppp-llc.

Default: "atm-ppp-vc-mux".

create-connection-profile-pppoa-response (vnd.net.juniper.space.device-management.modeled-device-management.create-connection-profile-pppoa-response;version=1)

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this create-connection-profile-pppoa-response node in the current node context. This link can be used to retrieve or operate on the currently referenced create-connection-profile-pppoa-response in the tree path.
connection-profilecreate-connection-profile-pppoa-response.connectionProfileMORESTNY Y * Connection profile details.

create-connection-profile-pppoa-response.connectionProfileMOREST

Connection profile details

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this connectionProfileMOREST node in the current node context. This link can be used to retrieve or operate on the currently referenced connectionProfileMOREST in the tree path.

Hyperlink Template: /api/space/device-management/modeled-device-management/connection-profiles/{*ID}.
@hrefString(URI)NY Y * Link to an external connectionProfileMOREST. Here, href points to the connectionProfileMOREST in the primary connectionProfileMOREST collection.

Hyperlink Template: /api/space/device-management/modeled-device-management/connection-profiles/{*ID}.
idIntegerYY N ID of the connection profile.
nameStringYY N Name of the connection profile.

create-connection-profile-pppoe-request (vnd.net.juniper.space.device-management.modeled-device-management.create-connection-profile-pppoe-request;version=1)

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this create-connection-profile-pppoe-request node in the current node context. This link can be used to retrieve or operate on the currently referenced create-connection-profile-pppoe-request in the tree path.
idIntegerYY N ID of the connection profile.
nameStringNY Y * Name of the connection profile.
descriptionStringNY Y Description of the connection profile.
interface-typeenum(interface-type)NY Y Type of the interface for which the connection profile is being set. Possible values: ETHERNET, T1.

Possible Values:
ETHERNET 
ADSL 
T1 

Default: ETHERNET.
interface-nameStringNY Y Name of the interface for which the connection profile is being set.

Default: "ge-0/0/0".
ip-typeStringNY Y System based parameter- Defines the ip type of connection profile.
use-natBooleanNY Y Is JNAP server behind NAT [NAT enabled].

Default: false.
auth-protocol-typeStringNY Y Auth Protocol CHAP or PAP.

Default: "CHAP".
user-nameStringNY Y * The CHAP username. Username to authenticate with the device.
passwordStringNY Y * The CHAP password.
access-profile-user-nameStringNY Y Access profile username.
access-profile-passwordStringNY Y Access profile password.
concentrator-nameStringNY Y Concentrator name for PPPoE.
service-nameStringNY Y The service name.
time-intervalIntegerNY Y PPPoE parameter-auto connect time interval.

Default: 1 Min: 0 Max: 6000.
idle-periodIntegerNY Y PPPoE parameter-ideal time before disconnect.

Default: 1 Min: 0 Max: 6000.

create-connection-profile-pppoe-response (vnd.net.juniper.space.device-management.modeled-device-management.create-connection-profile-pppoe-response;version=1)

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this create-connection-profile-pppoe-response node in the current node context. This link can be used to retrieve or operate on the currently referenced create-connection-profile-pppoe-response in the tree path.
connection-profilecreate-connection-profile-pppoe-response.connectionProfileMORESTNY Y * Connection profile details.

create-connection-profile-pppoe-response.connectionProfileMOREST

Connection profile details

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this connectionProfileMOREST node in the current node context. This link can be used to retrieve or operate on the currently referenced connectionProfileMOREST in the tree path.

Hyperlink Template: /api/space/device-management/modeled-device-management/connection-profiles/{*ID}.
@hrefString(URI)NY Y * Link to an external connectionProfileMOREST. Here, href points to the connectionProfileMOREST in the primary connectionProfileMOREST collection.

Hyperlink Template: /api/space/device-management/modeled-device-management/connection-profiles/{*ID}.
idIntegerYY N ID of the connection profile.
nameStringYY N Name of the connection profile.

create-connection-profile-static-request (vnd.net.juniper.space.device-management.modeled-device-management.create-connection-profile-static-request;version=1)

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this create-connection-profile-static-request node in the current node context. This link can be used to retrieve or operate on the currently referenced create-connection-profile-static-request in the tree path.
idIntegerYY N ID of the connection profile.
nameStringNY Y * Name of the connection profile.
descriptionStringNY Y Description of the connection profile.
interface-typeenum(interface-type)NY Y Type of the interface for which the connection profile is being set. Possible values: ETHERNET, ADSL, T1.

Possible Values:
ETHERNET 
ADSL 
T1 

Default: ETHERNET.
interface-nameStringNY Y Name of the interface for which the connection profile is being set.

Default: "ge-0/0/0".
ip-typeStringNY Y System based parameter- Defines the ip type of connection profile.
use-natBooleanNY Y Is JNAP server behind NAT [NAT enabled].

Default: false.

create-connection-profile-static-response (vnd.net.juniper.space.device-management.modeled-device-management.create-connection-profile-static-response;version=1)

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this create-connection-profile-static-response node in the current node context. This link can be used to retrieve or operate on the currently referenced create-connection-profile-static-response in the tree path.
connection-profilecreate-connection-profile-static-response.connectionProfileMORESTNY Y * Connection profile details.

create-connection-profile-static-response.connectionProfileMOREST

Connection profile details

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this connectionProfileMOREST node in the current node context. This link can be used to retrieve or operate on the currently referenced connectionProfileMOREST in the tree path.

Hyperlink Template: /api/space/device-management/modeled-device-management/connection-profiles/{*ID}.
@hrefString(URI)NY Y * Link to an external connectionProfileMOREST. Here, href points to the connectionProfileMOREST in the primary connectionProfileMOREST collection.

Hyperlink Template: /api/space/device-management/modeled-device-management/connection-profiles/{*ID}.
idIntegerYY N ID of the connection profile.
nameStringYY N Name of the connection profile.

ctps (vnd.net.juniper.space.managed-domain.ctps;version=4)

Collection of Logical Interfaces of the Device(s)

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this ctps node in the current node context. This link can be used to retrieve or operate on the currently referenced ctps in the tree path.
@totalIntegerYY N Total number of ctps in the API result set. If paging parameters are used in the query to limit the result set size, then total represents the total number of ctps in all the pages of the result set.
ctpctps.deviceLogicalInterface[]NY Y * Collection of Logical Interfaces of the Device(s).

ctps.deviceLogicalInterface

Collection of Logical Interfaces of the Device(s)

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)YY N NNLink to this deviceLogicalInterface node in the current node context. This link can be used to retrieve or operate on the currently referenced deviceLogicalInterface in the tree path.

Hyperlink Template: /api/space/managed-domain/ctps/{*ID}.
@hrefString(URI)YY N NNLink to an external deviceLogicalInterface. Here, href points to the deviceLogicalInterface in the primary ctps collection.

Hyperlink Template: /api/space/managed-domain/ctps/{*ID}.
vlan-idStringYY N YYVlan ID of the Logical Interface.
domain-idIntegerYY N YYUnique ID of the Domain to which the Device belongs to.
descriptionStringYY N YYDescription of the Logical Interface.
device-nameStringYY N YYName of the Device.
domain-nameStringYY N YYName of the Domain to which the Device belongs to.
ipv6-addressStringYY N YYIPv6 address of the Logical Interface.
idIntegerYY N YYUnique ID of the Logical Interface.
nameStringYY N YYName of the Logical Interface.
encapsulationenum(encapsulation)YY N YYEncapsulation of the Logical Interface.

Possible Values:
NONE 
DIX 
VLAN_BRIDGE 
VLAN_CCC 
VLAN_TCC 
VLAN_VPLS 
ATM_CCC_CELL_RELAY 
ATM_CCC_VC_MUX 
ATM_CISCO_NLPID 
ATM_MLPPP_LLC 
ATM_NLPID 
ATM_PPP_LLC 
ATM_PPP_VC_MUX 
ATM_SNAP 
ATM_TCC_SNAP 
ATM_TCC_VC_MUX 
ATM_VC_MUX 
ETHER_OVER_ATM_LLC 
ETHER_VPLS_OVER_ATM_LLC 
ETHER_VPLS_OVER_FR 
ETHER_VPLS_OVER_PPP 
ETHERNET 
FRAME_REPLAY_CCC 
FRAME_RELAY_ETHER_TYPE 
FRAME_RELAY_ETHER_TYPE_TCC 
FRAME_RELAY_PPP 
FRAME_RELAY_TCC 
MULTILINK_FRAME_RELAY_END_TO_END 
MULTILINK_PPP 
PPP_OVER_ETHER 
PPP_OVER_ETHER_OVER_ATM_LLC 
VLAN_VCI_CCC 

Default: NONE.
ipv4-addressStringYY N YYIPv4 address of the Logical Interface.
device-idIntegerYY N YYUnique ID of the Device.

customized-attribute-categories (vnd.net.juniper.space.tag-management.customized-attribute-categories;version=4)

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this customized-attribute-categories node in the current node context. This link can be used to retrieve or operate on the currently referenced customized-attribute-categories in the tree path.
@totalIntegerYY N Total number of customized-attribute-categories in the API result set. If paging parameters are used in the query to limit the result set size, then total represents the total number of customized-attribute-categories in all the pages of the result set.
customized-attribute-categorycustomized-attribute-categories.customizedAttributeCategory[]NY Y *  

customized-attribute-categories.customizedAttributeCategory

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)YY N NNLink to this customizedAttributeCategory node in the current node context. This link can be used to retrieve or operate on the currently referenced customizedAttributeCategory in the tree path.

Hyperlink Template: /api/space/tag-management/customized-attribute-categories/{*ID}.
@hrefString(URI)YY N NNLink to an external customizedAttributeCategory. Here, href points to the customizedAttributeCategory in the primary customized-attribute-categories collection.

Hyperlink Template: /api/space/tag-management/customized-attribute-categories/{*ID}.
idIntegerYY N NNCustomizedAttributeCategory ID.
categoryStringNY Y * NNCategory.

customized-attribute-category (vnd.net.juniper.space.tag-management.customized-attribute-category;version=4)

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this customized-attribute-category node in the current node context. This link can be used to retrieve or operate on the currently referenced customized-attribute-category in the tree path.

Hyperlink Template: /api/space/tag-management/customized-attribute-categories/{*ID}.
@hrefString(URI)YY N Link to an external customized-attribute-category. Here, href points to the customized-attribute-category in the primary customized-attribute-categories collection.

Hyperlink Template: /api/space/tag-management/customized-attribute-categories/{*ID}.
*idIntegerYY N CustomizedAttributeCategory ID.
categoryStringNY Y * Category.

customized-attribute-label (vnd.net.juniper.space.tag-management.customized-attribute-label;version=4)

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this customized-attribute-label node in the current node context. For primary collection members, href and uri are always the same.

Hyperlink Template: /api/space/tag-management/customized-attribute-labels/{*ID}.
@hrefString(URI)YY N Link to an external customized-attribute-label. Here, href points to the customized-attribute-label in the primary customized-attribute-labels collection.

Hyperlink Template: /api/space/tag-management/customized-attribute-labels/{*ID}.
*idIntegerYY N CustomizedAttributeLabel ID.
promoted-column-indexIntegerNY Y * Promoted Column Index.
customized-attribute-categorycustomized-attribute-label.customizedAttributeCategoryNY Y  
nameStringNY Y * CustomizedAttributeLabel Name.

customized-attribute-label.customizedAttributeCategory

Field NameTypeRead OnlyGETPUT / POSTDescription
@hrefString(URI)NY Y * Link to an external customizedAttributeCategory. Here, href points to the customizedAttributeCategory in the primary customized-attribute-categories collection.

Hyperlink Template: /api/space/tag-management/customized-attribute-categories/{*ID}.
idIntegerYY N CustomizedAttributeCategory ID.

customized-attribute-labels (vnd.net.juniper.space.tag-management.customized-attribute-labels;version=4)

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this customized-attribute-labels node in the current node context. This link can be used to retrieve or operate on the currently referenced customized-attribute-labels in the tree path.
@totalIntegerYY N Total number of customized-attribute-labels in the API result set. If paging parameters are used in the query to limit the result set size, then total represents the total number of customized-attribute-labels in all the pages of the result set.
customized-attribute-labelcustomized-attribute-labels.customizedAttributeLabel[]NY Y *  

customized-attribute-labels.customizedAttributeLabel

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)YY N NNLink to this customizedAttributeLabel node in the current node context. This link can be used to retrieve or operate on the currently referenced customizedAttributeLabel in the tree path.

Hyperlink Template: /api/space/tag-management/customized-attribute-labels/{*ID}.
@hrefString(URI)YY N NNLink to an external customized-attribute-label. Here, href points to the customized-attribute-label in the primary customized-attribute-labels collection.

Hyperlink Template: /api/space/tag-management/customized-attribute-labels/{*ID}.
idIntegerYY N NNCustomizedAttributeLabel ID.
promoted-column-indexIntegerNY Y * NNPromoted Column Index.
customized-attribute-categorycustomized-attribute-labels.customizedAttributeLabel.customizedAttributeCategoryNY Y NN 
nameStringNY Y * NNCustomizedAttributeLabel Name.

customized-attribute-labels.customizedAttributeLabel.customizedAttributeCategory

Field NameTypeRead OnlyGETPUT / POSTDescription
@hrefString(URI)NY Y * Link to an external customizedAttributeCategory. Here, href points to the customizedAttributeCategory in the primary customized-attribute-categories collection.

Hyperlink Template: /api/space/tag-management/customized-attribute-categories/{*ID}.
idIntegerYY N CustomizedAttributeCategory ID.

customized-attribute-value (vnd.net.juniper.space.device-management.customized-attribute-value;version=3)

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this customized-attribute-value node in the current node context. This link can be used to retrieve or operate on the currently referenced customized-attribute-value in the tree path.
idIntegerYY N CustomizedAttributeValue ID.
valueStringNY Y * Value.
customized-attribute-labelcustomized-attribute-value.customizedAttributeLabelNY Y *  

customized-attribute-value.customizedAttributeLabel

Field NameTypeRead OnlyGETPUT / POSTDescription
@hrefString(URI)NY Y * Link to an external customizedAttributeLabel. Here, href points to the customizedAttributeLabel in the primary customizedAttributeLabel collection.

Hyperlink Template: /api/space/tag-management/customized-attribute-labels/{*ID}.
idIntegerYY N CustomizedAttributeLabel ID.
nameStringYY N CustomizedAttributeLabel Name.

customized-attribute-value-refs (vnd.net.juniper.space.device-management.customized-attribute-value-refs;version=3)

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this customized-attribute-value-refs node in the current node context. This link can be used to retrieve or operate on the currently referenced customized-attribute-value-refs in the tree path.
@totalIntegerYY N Total number of customized-attribute-values in the API result set. If paging parameters are used in the query to limit the result set size, then total represents the total number of customized-attribute-values in all the pages of the result set.
customized-attribute-valuecustomized-attribute-value-refs.customizedAttributeValue[]NY Y *  

customized-attribute-value-refs.customizedAttributeValue

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@hrefString(URI)NY Y * NNLink to an external customizedAttributeValue. Here, href points to the customizedAttributeValue in the primary customizedAttributeValue collection.

Hyperlink Template: /api/space/device-management/devices/{*ID}/customized-attribute-values/{*ID}.
idIntegerYY N YYCustomizedAttributeValue ID.
entity-row-idIntegerYY N NNEntity Row ID.
valueStringYY N YYValue.
customized-attribute-labelcustomized-attribute-value-refs.customizedAttributeValue.customizedAttributeLabelYY N NN 

customized-attribute-value-refs.customizedAttributeValue.customizedAttributeLabel

Field NameTypeRead OnlyGETPUT / POSTDescription
@hrefString(URI)NY Y * Link to an external customizedAttributeLabel. Here, href points to the customizedAttributeLabel in the primary customizedAttributeLabel collection.

Hyperlink Template: /api/space/tag-management/customized-attribute-labels/{*ID}.
idIntegerYY N CustomizedAttributeLabel ID.
nameStringYY N CustomizedAttributeLabel Name.

delete-config-template-versions-request (vnd.net.juniper.space.config-template-management.delete-config-template-versions-request;version=3)

Collection of version numbers to be deleted

Field NameTypeRead OnlyGETPUT / POSTDescription
version-listdelete-config-template-versions-request.versionListsNY Y * list of versions to be deleted.

delete-config-template-versions-request.versionLists

list of versions to be deleted

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this versionLists node in the current node context. This link can be used to retrieve or operate on the currently referenced versionLists in the tree path.
versionInteger[]NY Y * Version Lists.

delete-config-template-with-versions-request (vnd.net.juniper.space.config-template-management.delete-config-template-with-versions-request;version=3)

Field NameTypeRead OnlyGETPUT / POSTDescription
template-id-with-verdelete-config-template-with-versions-request.templateIdWithVersNY Y *  

delete-config-template-with-versions-request.templateIdWithVers

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this templateIdWithVers node in the current node context. This link can be used to retrieve or operate on the currently referenced templateIdWithVers in the tree path.
template-id-with-verString[]NY Y * Template ID With Vers.

delete-device-discovery-rules-request (vnd.net.juniper.space.device-management.delete-device-discovery-rules-request;version=6)

Field NameTypeRead OnlyGETPUT / POSTDescription
device-discovery-rulesdelete-device-discovery-rules-request.deviceTargetRulesNY Y *  

delete-device-discovery-rules-request.deviceTargetRules

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this deviceTargetRules node in the current node context. This link can be used to retrieve or operate on the currently referenced deviceTargetRules in the tree path.
device-discovery-ruledelete-device-discovery-rules-request.deviceTargetRules.deviceDiscoveryRule[]NY Y *  

delete-device-discovery-rules-request.deviceTargetRules.deviceDiscoveryRule

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@hrefString(URI)NY Y * NNLink to an external device-discovery-rule. Here, href points to the device-discovery-rule in the primary device-discovery-rules collection.

Hyperlink Template: /api/space/device-management/device-discovery-rules/{*ID}.
idIntegerYY N YYDeviceDiscoveryRule ID.

delete-device-discovery-rules-response (vnd.net.juniper.space.device-management.delete-device-discovery-rules-response;version=6)

Field NameTypeRead OnlyGETPUT / POSTDescription
valueStringNY Y * Value.

delete-devices-job-results (vnd.net.juniper.space.device-management.job-instances.delete-devices-job-results;version=3)

Collection of Delete Devices Job Result on which the given Delete Job is triggered

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this delete-devices-job-results node in the current node context. This link can be used to retrieve or operate on the currently referenced delete-devices-job-results in the tree path.
@totalIntegerYY N Total number of delete-devices-job-results in the API result set. If paging parameters are used in the query to limit the result set size, then total represents the total number of delete-devices-job-results in all the pages of the result set.
delete-device-job-resultdelete-devices-job-results.deleteDeviceResult[]NY Y * Delete Device Job Result Entry.

delete-devices-job-results.deleteDeviceResult

Delete Device Job Result Entry

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)YY N NNLink to this deleteDeviceResult node in the current node context. This link can be used to retrieve or operate on the currently referenced deleteDeviceResult in the tree path.
idIntegerYY N NNJob result table row ID.
delete-fail-reasonStringNY Y * YNIf device Delete failed, set the fail reason.
devicedelete-devices-job-results.deleteDeviceResult.deviceNY Y * NN 
delete-device-statusenum(delete-device-status)NY Y * YYDelete device status.

Possible Values:
FAILEDFailed
SUCCESSSuccess
.
hostnameStringNY Y YYHostname.
device-idIntegerNY Y * YYdevice id.
ipStringNY Y YNip address.

delete-devices-job-results.deleteDeviceResult.device

Field NameTypeRead OnlyGETPUT / POSTDescription
@hrefString(URI)NY Y * Link to an external device. Here, href points to the device in the primary device collection.

Hyperlink Template: /api/space/managed-domain/devices-require-polling/{*ID}.
idIntegerYY N Device ID.
nameStringYY N Device Name.

delete-devices-request (vnd.net.juniper.space.device-management.delete-devices-request;version=3)

Execute Delete Device

Field NameTypeRead OnlyGETPUT / POSTDescription
devicesdelete-devices-request.deviceListsNY Y * Devices to be deleted.

delete-devices-request.deviceLists

Devices to be deleted

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this deviceLists node in the current node context. This link can be used to retrieve or operate on the currently referenced deviceLists in the tree path.
devicedelete-devices-request.deviceLists.device[]NY Y * Device to be deleted.

delete-devices-request.deviceLists.device

Device to be deleted

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@hrefString(URI)NY Y * NNLink to an external device. Here, href points to the device in the primary device collection.

Hyperlink Template: /api/space/device-management/devices/{*ID}.
idIntegerYY N YYDevice ID.
nameStringYY N YYDevice Name.

delete-domain-job-results (vnd.net.juniper.space.domain-management.delete-domain-job-results;version=2)

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this delete-domain-job-results node in the current node context. This link can be used to retrieve or operate on the currently referenced delete-domain-job-results in the tree path.
@totalIntegerYY N Total number of delete-domain-job-results in the API result set. If paging parameters are used in the query to limit the result set size, then total represents the total number of delete-domain-job-results in all the pages of the result set.
delete-domain-job-resultdelete-domain-job-results.deleteDomainJobResult[]NY Y *  

delete-domain-job-results.deleteDomainJobResult

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)YY N NNLink to this deleteDomainJobResult node in the current node context. This link can be used to retrieve or operate on the currently referenced deleteDomainJobResult in the tree path.
application-nameStringNY Y * YNApplication Name.
idIntegerYY N NNDomain ID.
descriptionStringNY Y * NNDescription.
domain-nameStringYY N NNDomain Name.
job-instance-idIntegerNY Y * NNJob Instance ID.

delete-fabric-node-request (vnd.api.space.fabric-management.fabric-node.delete-fabric-node-request;version=2)

Information used for deleting a node from the fabric

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this delete-fabric-node-request node in the current node context. This link can be used to retrieve or operate on the currently referenced delete-fabric-node-request in the tree path.
fabric-nodedelete-fabric-node-request.fabricNodeNY Y * The Fabric node which has to be deleted.
alternative-fabric-nodedelete-fabric-node-request.alternativeNodeNY 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.

delete-fabric-node-request.fabricNode

The Fabric node which has to be deleted.

Field NameTypeRead OnlyGETPUT / POSTDescription
@hrefString(URI)NY Y * Link to an external fabricNode. Here, href points to the fabricNode in the primary fabricNode collection.

Hyperlink Template: /api/space/fabric-management/fabric-nodes/{*ID}.
idIntegerYY N Fabric Node ID.
nameStringYY 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). For each subsequent node, the user must specify a node name when adding the node to the fabric.

delete-fabric-node-request.alternativeNode

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 NameTypeRead OnlyGETPUT / POSTDescription
@hrefString(URI)NY Y * Link to an external alternativeNode. Here, href points to the alternativeNode in the primary alternativeNode collection.

Hyperlink Template: /api/space/fabric-management/fabric-nodes/{*ID}.
idIntegerYY N Fabric Node ID.
nameStringYY 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). For each subsequent node, the user must specify a node name when adding the node to the fabric.

delete-hprof-files-request (vnd.net.juniper.space.fabric-management.delete-hprof-files-request;version=3)

Field NameTypeRead OnlyGETPUT / POSTDescription
fabric-hprof-filesdelete-hprof-files-request.fabricHprofFilesNY Y *  

delete-hprof-files-request.fabricHprofFiles

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this fabricHprofFiles node in the current node context. This link can be used to retrieve or operate on the currently referenced fabricHprofFiles in the tree path.
fabric-hprof-filedelete-hprof-files-request.fabricHprofFiles.fabricHprofFile[]NY Y *  

delete-hprof-files-request.fabricHprofFiles.fabricHprofFile

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@hrefString(URI)NY Y * NNLink to an external fabric-hprof-file. Here, href points to the fabric-hprof-file in the primary fabric-hprof-files collection.

Hyperlink Template: /api/space/fabric-management/hprof-files/{*ID}.
idIntegerYY N NNID.

delete-schemas (vnd.net.juniper.space.schema-service.delete-schemas;version=2)

Field NameTypeRead OnlyGETPUT / POSTDescription
dmi-schema-infosdelete-schemas.dmiSchemaInfosNY Y * List of schemas to delete.

delete-schemas.dmiSchemaInfos

List of schemas to delete

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this dmiSchemaInfos node in the current node context. This link can be used to retrieve or operate on the currently referenced dmiSchemaInfos in the tree path.
dmi-schema-infodelete-schemas.dmiSchemaInfos.dmiSchemaInfo[]NY Y * Specify a device family and an os version (release) for each schema to be deleted.

delete-schemas.dmiSchemaInfos.dmiSchemaInfo

Specify a device family and an os version (release) for each schema to be deleted

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)YY N NNLink to this dmiSchemaInfo node in the current node context. This link can be used to retrieve or operate on the currently referenced dmiSchemaInfo in the tree path.
os-versionStringNY Y * YNRelease/OS Version.
dev-familyStringNY Y * YNDevice Family.

denied-jobs-request (vnd.net.juniper.space.job-management.denied-jobs-request;version=3)

Field NameTypeRead OnlyGETPUT / POSTDescription
jobsdenied-jobs-request.instanceManagedObjectsNY Y *  

denied-jobs-request.instanceManagedObjects

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this instanceManagedObjects node in the current node context. This link can be used to retrieve or operate on the currently referenced instanceManagedObjects in the tree path.
jobdenied-jobs-request.instanceManagedObjects.monitorableTaskInstanceManagedObject[]NY Y *  

denied-jobs-request.instanceManagedObjects.monitorableTaskInstanceManagedObject

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@hrefString(URI)NY Y * NNLink to an external monitorableTaskInstanceManagedObject. Here, href points to the monitorableTaskInstanceManagedObject in the primary monitorableTaskInstanceManagedObject collection.

Hyperlink Template: /api/space/job-management/jobs/{*ID}.
idIntegerYY N YYThe ID of the job.
nameStringYY N NNMonitorableTaskInstanceManagedObject Name.

deploy-configuration-job-results (vnd.net.juniper.space.configuration-management.deploy-configuration-job-results;version=4)

Collection of Deploy Configuration job result details

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this deploy-configuration-job-results node in the current node context. This link can be used to retrieve or operate on the currently referenced deploy-configuration-job-results in the tree path.
@totalIntegerYY N Total number of deploy-configuration-job-results in the API result set. If paging parameters are used in the query to limit the result set size, then total represents the total number of deploy-configuration-job-results in all the pages of the result set.
deploy-configuration-job-resultdeploy-configuration-job-results.consolidatedConfigJobResult[]NY Y * Deploy Configuration job result detail.

deploy-configuration-job-results.consolidatedConfigJobResult

Deploy Configuration job result detail

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)YY N NNLink to this consolidatedConfigJobResult node in the current node context. This link can be used to retrieve or operate on the currently referenced consolidatedConfigJobResult in the tree path.
idIntegerYY N YYJob result table row ID.
ipStringYY N YYIP.
host-nameStringYY N YYHost Name.
device-idIntegerYY N YYDevice ID.
statusenum(status)YY N YYStatus.

Possible Values:
FAILEDFailed
SUCCESSSuccess
.
job-instance-idIntegerYY N YYJob Instance ID.
job-failed-reasonStringYY N NNJob Failed Reason.
deploy-dataStringYY N NNDeploy Data.
deviceStringYY N NNDevice Link

Hyperlink Template: /api/space/device-management/devices/{*ID}.
jobStringYY N NNJob Link

Hyperlink Template: /api/space/job-management/jobs/{*ID}.

device (vnd.net.juniper.space.device-management.device;version=1)

The 'device' resource model represents detailed information about the device. It consists of the following fields:

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)NY Y * Link to this device node in the current node context. This link can be used to retrieve or operate on the currently referenced device in the tree path.
deviceFamilyStringNY Y Device family that the device belongs to (for example, MX).
OSVersionStringNY Y OS version of the device
platformStringNY Y Platform of the device
serialNumberStringNY Y Serial number of the device.
nameStringNY Y Name of the device.
hostNameStringNY Y Host Name of the device.
idIntegerNY Y * Unique identifier for the 'device'.
ipAddrStringNY Y IP Address of the device.
otpStringNY Y OTP connection of the device.
domain-idIntegerNY Y domain id of device.
domain-nameStringNY Y domain name of the device.
connection-typeStringNY Y Connection type of the Device
attribute-column-0StringNY Y Custom Attribute for Device.
use-natbooleanNY Y * An attribute that describes the device is connected to NAT or not.
authentication-statusenum(authentication-status)NY Y Authentication status of the Device

Possible Values:
CREDENTIALCredentials Based
RSA_KEYKey Based
KEY_CONFLICTKey Conflict
NOT_AVAILABLENA
CREDENTIAL_UNVERIFIEDCredentials Based - Unverified
RSA_KEY_UNVERIFIEDKey Based - Unverified
KEY_CONFLICT_UNVERIFIEDKey Conflict - Unverified
FINGER_PRINT_CONFLICTFingerprint Conflict
CUSTOM_KEYCustom Key Based
CUSTOM_KEY_UNVERIFIEDCustom Key - Unverified
device-idintNY Y Unique Identifier of Device
web-mgmtStringNY Y Web management protocol
lsys-countintNY Y Device Lsys Count
rootLsysDeviceDONY Y Device Lsys Root
hosting-deviceIdintNY Y Hosting Device ID
adapter-nameStringNY Y Name of the Adapter used for Device discovery
config-statusenum(config-status)NY Y Config Status

Possible Values:
DEVICE_STATE_AWAIT_1STCONNIMConnecting
DEVICE_STATE_IN_SYNCIn Sync
DEVICE_STATE_UNDEFNone
DEVICE_STATE_OUT_OF_SYNCOut Of Sync
DEVICE_STATE_SYNC_FAILEDSync Failed
DEVICE_STATE_SYNCHRONIZINGSynchronizing
DEVICE_STATE_MODELEDModeled
DEVICE_STATE_IN_RMAIn RMA
DEVICE_STATE_RMA_REACTIVATINGReactivating
DEVICE_STATE_RMA_REACTIVATE_FAILEDReactivate Failed
DEVICE_STATE_SSOR_UNDEFUndefined
DEVICE_STATE_SSOR_UNKNOWNUnknown
DEVICE_STATE_SSOR_IN_SYNCIn Sync
DEVICE_STATE_SSOR_SPACE_CHANGEDSpace Changed
DEVICE_STATE_SSOR_DEVICE_CHANGEDDevice Changed
DEVICE_STATE_SSOR_BOTH_CHANGEDSpace & Device Changed
DEVICE_STATE_UNMANAGEDUnmanaged
DEVICE_STATE_ACTIVATEDWaiting for Deployment
device-typeenum(device-type)NY Y Device Type.

Possible Values:
LSYS 
ROOT 
schema-versionStringNY Y schema verision of the device.
change-requestsdevice.changeRequestsNY Y Change-requests for the respective device.
managed-elementsdevice.managedElementsNY Y Managed elements of the device.
connection-statusdevice.connectionStatusNY Y Active connection Status of the device
managed-statusdevice.managedStatusNY Y Managed status of the device
configurationsStringNY Y Location of 'configuration' resource.
rpcStringNY Y Location of 'rpc' resource.
config-filesStringNY Y Location of 'config-files' resource.
associated-scriptsStringNY Y The association of device to scripts.
associated-softwaresStringNY Y The association of device to softwares.
activate-modeled-deviceStringNY Y Activate modeled device.
cloneStringNY Y Clone device.
modify-device-target-ipStringNY Y Modify Target IP.
configletStringNY Y view configlet.
domainStringYY N  
apply-cli-configletStringYY N  
submit-cli-configletStringYY N  
compute-configlet-parameter-valuesStringYY N  
applicable-configletsStringYY N  
validate-cli-configletStringYY N  
customized-attribute-valuesStringYY N  

device.changeRequests

The 'change-requests' field of type 'changeRequests' represents information about the change-request for the device. It consists of the following fields:

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)NY Y * Link to this changeRequests node in the current node context. This link can be used to retrieve or operate on the currently referenced changeRequests in the tree path.
change-requestdevice.changeRequests.changeRequest[]NY Y The collection of objects of type 'change-request'. Each object represents that a change-request is present.

device.changeRequests.changeRequest

The 'change-requests' field of type 'changeRequests' represents information about the change-request for the device. It consists of the following fields:

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@hrefString(URI)NY Y * NNLink to an external changeRequest. Here, href points to the changeRequest in the primary changeRequest collection.
@uriString(URI)NY Y * NNLink to this changeRequest node in the current node context. This link can be used to retrieve or operate on the currently referenced changeRequest in the tree path.
@keyIntegerNY Y * NN Unique identifier for the change request.
deviceIdLongNY Y * NN Unique identifier for device.
nameStringNY Y NN The change-request name.

device.managedElements

The 'managed-elements' field of type 'managedElements' represents information about the managed elements of the device. It consists of the following fields:

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)NY Y * Link to this managedElements node in the current node context. This link can be used to retrieve or operate on the currently referenced managedElements in the tree path.
managed-elementdevice.managedElements.managedElementDTO[]NY Y A collection of managed elements. Each object in the collection represents details of a managed-elements.

device.managedElements.managedElementDTO

The 'managed-element' resource model represent a view of information about the managed-element for a device. It consists of the following fields:

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@hrefString(URI)NY Y * NNLink to an external managedElementDTO. Here, href points to the managedElementDTO in the primary managedElementDTO collection.
idIntegerNY Y * NN Unique identifier for the managed element.
ipAddrStringNY Y NN IP Address of the device.
deviceIdIntegerNY Y NN Unique identifier for device.

device.connectionStatus

The 'connectionStatus' resource model represent a view of information about the connection status for a device. It consists of the following fields:

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)NY Y * Link to this connectionStatus node in the current node context. This link can be used to retrieve or operate on the currently referenced connectionStatus in the tree path.
statusStringNY Y Connection status of device.

device.managedStatus

The 'managed-status' resource model represent a view of information about the managed-status for a device. It consists of the following fields:

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)NY Y * Link to this managedStatus node in the current node context. This link can be used to retrieve or operate on the currently referenced managedStatus in the tree path.
statusStringNY Y Status of device (for example, 'out-of-sync' or 'In-sync').

device (vnd.net.juniper.space.application-management.platform.settings.device;version=1)

The 'device' resource model represents device settings on Junos Space. It consists of the following fields:

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)NY Y Link to this device node in the current node context. This link can be used to retrieve or operate on the currently referenced device in the tree path.
auto-log-in-to-devicesStringNY Y Whether to enable or disable the auto-login to devices.
auto-resyncStringNY Y Whether to resynchronize devices automatically or not.
auto-resync-waiting-timeIntegerNY Y Waiting time in minutes for the auto-resynchronization of devices.
initiates-connectionStringNY Y Server initiated connection.
support-wwStringNY Y Whether WorldWide Junos OS adapter is supported or not.
ssh-portIntegerNY Y SSH port for the device.
polling-timeIntegerNY Y Time in minutes to poll the device.
commit-confirmed-for-configurationBooleanNY Y Enable commit confirmed for configuration deployment
approval-workflow-for-configBooleanNY Y Enable approval workflow for configuration deployment.
allow-device-communicationBooleanNY Y Allow Device Communication.
support-abort-for-close-sessionBooleanNY Y Support Abort For Close Session.
looking-glass-response-timeoutIntegerNY Y Looking Glass Device response timeout in seconds.
number-of-device-to-connect-for-space-initiatedIntegerNY Y Number of devices to connect per minute for Space Initiated Connection.
configure-commit-sync-during-device-discoveryBooleanNY Y Configure commit synchronize during device discovery.
add-snmp-configurationBooleanNY Y Add SNMP configuration to device.
disable-network-monitoringBooleanNY Y Disable network monitoring for all devices.
manually-resolve-fingerprint-conflictBooleanNY Y Support Manually Resolve Fingerprint Conflict.

device-associations (vnd.net.juniper.space.config-template-management.device-associations;version=1)

A device can be associated with one or more configuration templates.

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)NY Y Link to this device-associations node in the current node context. This link can be used to retrieve or operate on the currently referenced device-associations in the tree path.
@totalIntegerYY N Total number of device-associations in the API result set. If paging parameters are used in the query to limit the result set size, then total represents the total number of device-associations in all the pages of the result set.
device-associationdevice-associations.templateDeviceAssociation[]NY Y * The association between a device and a configuration template.

device-associations.templateDeviceAssociation

The association between a device and a configuration template.

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)NY Y NNLink to this templateDeviceAssociation node in the current node context. This link can be used to retrieve or operate on the currently referenced templateDeviceAssociation in the tree path.
device-nameStringNY Y * YNThe name of the device.
current-template-verIntegerNY Y * NNThe current version of the template.
deploy-statusenum(deploy-status)NY Y * NNThe status of the last deployment.

Possible Values:
DEPLOYED 
NOT_DEPLOYED 
DEPLOYMENT_REQUESTED 
.
audit-statusenum(audit-status)NY Y * YYThe status of last audit (exec-audit).

Possible Values:
OUTOFSYNC 
INSYNC 
NOTAVAIL 
.
template-versionIntegerNY Y * YNThe version of the configuration template deployed to this device.
published-template-versionIntegerNY Y * NNThe version of the configuration template published to this device.
deployed-byStringNY Y YNThe user who deployed the configuration template.
domain-idIntegerNY Y * NYThe ID of the domain to which the device belongs.
domain-nameStringNY Y * NNThe name of the domain to which the device belongs.
audit-job-idIntegerNY Y * YNThe ID of the audit job.
job-idIntegerNY Y * YNThe ID of the job.
publish-statusenum(publish-status)NY Y * NNThe status of last publish.

Possible Values:
PUBLISHED 
NOT_PUBLISHED 
.
order-seqIntegerNY Y * NNAn ordinal sequence of template publishing to a candidate configuration. Every time the template is published to a device, the order sequence is incremented. A user can change the order sequence through the Space user interface.When the template is published to the device, its versions are applied to the device in this order.
device-idIntegerNY Y * YNThe ID of the device.
deviceStringYY N NNThe device associated with this template

Hyperlink Template: /api/space/device-management/devices/{*ID}.
deployment-jobStringYY N NNThe job used when the template was last deployed to this device

Hyperlink Template: /api/space/job-management/jobs/{*ID}.
audit-jobStringYY N NNThe job used when the template was last audited

Hyperlink Template: /api/space/job-management/jobs/{*ID}.

device-associations (vnd.net.juniper.space.config-template-management.device-associations;version=3)

A device can be associated with one or more configuration templates.

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this device-associations node in the current node context. This link can be used to retrieve or operate on the currently referenced device-associations in the tree path.
@totalIntegerYY N Total number of device-associations-for-template-versions in the API result set. If paging parameters are used in the query to limit the result set size, then total represents the total number of device-associations-for-template-versions in all the pages of the result set.
device-templatedevice-associations.deviceTemplate[]NY Y *  

device-associations.deviceTemplate

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)YY N NNLink to this deviceTemplate node in the current node context. This link can be used to retrieve or operate on the currently referenced deviceTemplate in the tree path.
platformStringNY Y * YYPlatform.
device-ipStringNY Y * YYDevice IP.
device-nameStringNY Y YYDevice Name.
idStringNY Y NNMOID.
template-statusStringNY Y * NNTemplate Status.
software-releaseStringNY Y * YYSoftware Release.
statusStringNY Y * YYStatus.
template-verIntegerNY Y * NNTemplate Ver.
config-statusenum(config-status)NY Y * NNConfig Status.

Possible Values:
DEVICE_STATE_AWAIT_1STCONNIMConnecting
DEVICE_STATE_IN_SYNCIn Sync
DEVICE_STATE_UNDEFNone
DEVICE_STATE_OUT_OF_SYNCOut Of Sync
DEVICE_STATE_SYNC_FAILEDSync Failed
DEVICE_STATE_SYNCHRONIZINGSynchronizing
DEVICE_STATE_MODELEDModeled
DEVICE_STATE_IN_RMAIn RMA
DEVICE_STATE_RMA_REACTIVATINGReactivating
DEVICE_STATE_RMA_REACTIVATE_FAILEDReactivate Failed
DEVICE_STATE_SSOR_UNDEFUndefined
DEVICE_STATE_SSOR_UNKNOWNUnknown
DEVICE_STATE_SSOR_IN_SYNCIn Sync
DEVICE_STATE_SSOR_SPACE_CHANGEDSpace Changed
DEVICE_STATE_SSOR_DEVICE_CHANGEDDevice Changed
DEVICE_STATE_SSOR_BOTH_CHANGEDSpace & Device Changed
DEVICE_STATE_UNMANAGEDUnmanaged
DEVICE_STATE_ACTIVATEDWaiting for Deployment
.

device-by-ids (vnd.net.juniper.space.device-management.device-by-ids;version=3)

Contains device id's array for request

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this device-by-ids node in the current node context. This link can be used to retrieve or operate on the currently referenced device-by-ids in the tree path.
@totalIntegerYY N Total number of device-by-ids in the API result set. If paging parameters are used in the query to limit the result set size, then total represents the total number of device-by-ids in all the pages of the result set.
devicedevice-by-ids.device[]NY Y *  

device-by-ids.device

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)YY N NNLink to this device node in the current node context. This link can be used to retrieve or operate on the currently referenced device in the tree path.

Hyperlink Template: /{*ID}.
@hrefString(URI)YY N NNLink to an external device. Here, href points to the device in the primary device collection.

Hyperlink Template: /api/space/managed-domain/devices-require-polling/{*ID}.
OSVersionStringNY Y YYOS Version.
statusStringYY N YYStatus.
lsys-countIntegerNY Y NNLsys Count.
dev-adminStringYY N NNDev Admin.
software-releaseStringYY N YYSoftware Release.
discovery-ipStringYY N NNDiscovery IP.
hosting-deviceIdIntegerNY Y NNHosting Device ID.
device-connection-typeStringYY N NNDevice Connection Type.
newFingerprintStringNY Y NNDev Conflict Fingerprint.
virtual-chassis-statusBooleanYY N NNVirtual Chassis Status.
fingerprintStringNY Y NNDev Fingerprint.
ipAddrStringNY Y YYIP Addr.
vendorStringYY N YYVendor.
device-uuiddevice-by-ids.device.deviceUUIDYY N NN 
adapter-nameStringYY N NNAdapter Name.
device-typeStringYY N NNDevice Type.
device-ipStringYY N YYDevice IP.
authentication-statusenum(authentication-status)YY N YYAuthentication Status.

Possible Values:
CREDENTIALCredentials Based
RSA_KEYKey Based
KEY_CONFLICTKey Conflict
NOT_AVAILABLENA
CREDENTIAL_UNVERIFIEDCredentials Based - Unverified
RSA_KEY_UNVERIFIEDKey Based - Unverified
KEY_CONFLICT_UNVERIFIEDKey Conflict - Unverified
FINGER_PRINT_CONFLICTFingerprint Conflict
CUSTOM_KEYCustom Key Based
CUSTOM_KEY_UNVERIFIEDCustom Key - Unverified
.
original-platformStringYY N NNOriginal Platform.
platformStringNY Y YYPlatform.
dev-admin-passwdStringYY N NNDev Admin Passwd.
staged-status-from-viewenum(staged-status-from-view)YY N YYStaged Status From View.

Possible Values:
NOTSTAGEDNot Staged
STAGEDStaged
.
domain-idIntegerYY N NYDomain ID.
logical-interfacesStringYY N NNLogical Interfaces.
matching-schemaStringYY N NYMatching Schema.
idIntegerYY N YYId of the device.
nameStringYY N YYName of the device.
staged-statusenum(staged-status)YY N NNStaged Status.

Possible Values:
NOTSTAGEDNot Staged
STAGEDStaged
.
display-nameStringYY N YYDisplay Name.
domain-nameStringYY N NNDomain Name.
device-familyStringYY N YYDevice Family.
config-statusenum(config-status)YY N NNConfig Status.

Possible Values:
DEVICE_STATE_AWAIT_1STCONNIMConnecting
DEVICE_STATE_IN_SYNCIn Sync
DEVICE_STATE_UNDEFNone
DEVICE_STATE_OUT_OF_SYNCOut Of Sync
DEVICE_STATE_SYNC_FAILEDSync Failed
DEVICE_STATE_SYNCHRONIZINGSynchronizing
DEVICE_STATE_MODELEDModeled
DEVICE_STATE_IN_RMAIn RMA
DEVICE_STATE_RMA_REACTIVATINGReactivating
DEVICE_STATE_RMA_REACTIVATE_FAILEDReactivate Failed
DEVICE_STATE_SSOR_UNDEFUndefined
DEVICE_STATE_SSOR_UNKNOWNUnknown
DEVICE_STATE_SSOR_IN_SYNCIn Sync
DEVICE_STATE_SSOR_SPACE_CHANGEDSpace Changed
DEVICE_STATE_SSOR_DEVICE_CHANGEDDevice Changed
DEVICE_STATE_SSOR_BOTH_CHANGEDSpace & Device Changed
DEVICE_STATE_UNMANAGEDUnmanaged
DEVICE_STATE_ACTIVATEDWaiting for Deployment

Default: DEVICE_STATE_UNDEF.

device-by-ids.device.deviceUUID

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this deviceUUID node in the current node context. This link can be used to retrieve or operate on the currently referenced deviceUUID in the tree path.
categoryStringNY Y * Category.
serviceStringNY Y * Service.
row-idIntegerYY N Row ID.

device-by-ids-request (vnd.net.juniper.space.device-management.device-by-ids-request;version=3)

Contains device id's array for request

Field NameTypeRead OnlyGETPUT / POSTDescription
device-idsdevice-by-ids-request.deviceIdsYY N contains list device Id tag.

device-by-ids-request.deviceIds

contains list device Id tag

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this deviceIds node in the current node context. This link can be used to retrieve or operate on the currently referenced deviceIds in the tree path.
device-idString[]NY Y * Device Id.

device-discovery-rule (vnd.net.juniper.space.device-management.device-discovery-rule;version=6)

Field NameTypeRead OnlyGETPUT / POSTPATCHDescription
@uriString(URI)YY N NLink to this device-discovery-rule node in the current node context. For primary collection members, href and uri are always the same.

Hyperlink Template: /api/space/device-management/device-discovery-rules/{*ID}.
@hrefString(URI)YY N NLink to an external device-discovery-rule. Here, href points to the device-discovery-rule in the primary device-discovery-rules collection.

Hyperlink Template: /api/space/device-management/device-discovery-rules/{*ID}.
*idIntegerYY N NDeviceDiscoveryRule ID.
discovery-profile-nameStringNY Y YDiscovery Profile Name.
target-detailsStringNY Y YTarget details (10.155.60.1, 10.155.60.1-10.155.60.10, 10.155.60.1/24, Sunnyvale-ISG, sample_discovery.csv).
use-natBooleanNY Y * YuseNAT flag.

Default: false.
use-pingBooleanNY Y YusePing flag.

Default: false.
sharableBooleanNY Y YProfile sharable status.

Default: true.
use-snmpBooleanNY Y YuseSnmp flag.

Default: false.
discovery-job-detailsdevice-discovery-rule.monitorableTaskInstanceManagedObjectNY Y Y 
discovery-typeenum(discovery-type)NY Y YDiscovery type (i.e) IP_ADDRESS, IP_RANGE, IP-SUBNET, HOSTNAME and IMPORT_BY_CSV.

Possible Values:
IMPORT_BY_CSVIMPORT BY CSV
HOSTNAME 
IP_ADDRESSIP ADDRESS
IP_RANGEIP RANGE
IP_SUBNETIP SUBNET
IP_HOSTNAMEIP HOSTNAME

Default: IP_ADDRESS.
device-targetsdevice-discovery-rule.deviceTargetsNY Y * Y 
device-snmp-versionenum(device-snmp-version)NY Y YSNMP version.

Possible Values:
NOT_APPLICABLEN/A
SNMPV1V2C 
SNMPV3 
.
device-snmp-detailsdevice-discovery-rule.deviceSnmpDetailNY Y Y 
domain-idIntegerYY N NDomain ID.
domain-nameStringYY N NDomain Name.
discovery-action-additional-paramsdevice-discovery-rule.discoveryActionParamsNY Y YDiscovery Action additional parameter configuration.
is-run-nowBooleanYY N NIs discovery job is of run now type flag.

device-discovery-rule.monitorableTaskInstanceManagedObject

Field NameTypeRead OnlyGETPUT / POSTDescription
@hrefString(URI)NY Y * Link to an external monitorableTaskInstanceManagedObject. Here, href points to the monitorableTaskInstanceManagedObject in the primary monitorableTaskInstanceManagedObject collection.

Hyperlink Template: /api/space/job-management/jobs/{*ID}.
idIntegerYY N MonitorableTaskInstanceManagedObject ID.
nameStringYY N MonitorableTaskInstanceManagedObject Name.
scheduled-start-time-stringStringYY N Scheduled Start Time String REST.
schedule-stringStringYY N Schedule String.
supports-recurrenceBooleanYY N Supports Recurrence.

Default: false.

device-discovery-rule.deviceTargets

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this deviceTargets node in the current node context. This link can be used to retrieve or operate on the currently referenced deviceTargets in the tree path.

Hyperlink Template: /api/space/device-management/device-discovery-rules/{*ID}/device-targets.
device-targetdevice-discovery-rule.deviceTargets.deviceTarget[]NY Y *  

device-discovery-rule.deviceTargets.deviceTarget

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)YY N NNLink to this deviceTarget node in the current node context. This link can be used to retrieve or operate on the currently referenced deviceTarget in the tree path.
idIntegerYY N NNId of device Target.
ip-addressStringNY Y NNip-address of device to be discovered.
host-nameStringNY Y NNHost name of device to be discovered.
base-ipStringNY Y NNNetwork ip of a network to be discovered.
subnet-maskStringNY Y NNSub-net mask of the above mentioned network.
lower-ipStringNY Y NNLower ip address of a network to be discovered.
upper-ipStringNY Y NNupper ip address of a network to be discovered.
tagsdevice-discovery-rule.deviceTargets.deviceTarget.tagListsNY Y NN 
device-ssh-credentialsdevice-discovery-rule.deviceTargets.deviceTarget.deviceSshCredentialsNY Y * NN 
device-fingerprintsdevice-discovery-rule.deviceTargets.deviceTarget.deviceFingerprintsNY Y NN 

device-discovery-rule.deviceTargets.deviceTarget.tagLists

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this tagLists node in the current node context. This link can be used to retrieve or operate on the currently referenced tagLists in the tree path.
tagString[]NY Y * Tag.

device-discovery-rule.deviceTargets.deviceTarget.deviceSshCredentials

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this deviceSshCredentials node in the current node context. This link can be used to retrieve or operate on the currently referenced deviceSshCredentials in the tree path.

Hyperlink Template: /api/space/device-management/device-discovery-rules/{*ID}/device-targets/device-ssh-credentials.
@totalIntegerYY N Total number of gen_device-discovery-rule-device-targets-device-targets-device-ssh-credentials in the API result set. If paging parameters are used in the query to limit the result set size, then total represents the total number of gen_device-discovery-rule-device-targets-device-targets-device-ssh-credentials in all the pages of the result set.
device-ssh-credentialdevice-discovery-rule.deviceTargets.deviceTarget.deviceSshCredentials.deviceSshCredential[]NY Y *  

device-discovery-rule.deviceTargets.deviceTarget.deviceSshCredentials.deviceSshCredential

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)YY N NNLink to this deviceSshCredential node in the current node context. This link can be used to retrieve or operate on the currently referenced deviceSshCredential in the tree path.
idIntegerYY N NNDevice credential id.
usernameStringNY Y * NNName of user on the node used for authentication while discovery.
passwordStringNY Y * NNPassword for authentication.
keybasedBooleanNY Y NNTrue to enable key-based authentication. Password not need if this is true.

Default: false.
credential-typeenum(credential-type)NY Y NNCredential Type.

Possible Values:
CREDENTIAL_BASEDCredential Based
KEY_BASEDKey Based
CUSTOM_KEY_BASEDCustom Key Based
.
pass-phraseStringNY Y NNPass Phrase.
private-keyStringNY Y NNPrivate Key.

device-discovery-rule.deviceTargets.deviceTarget.deviceFingerprints

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this deviceFingerprints node in the current node context. This link can be used to retrieve or operate on the currently referenced deviceFingerprints in the tree path.

Hyperlink Template: /api/space/device-management/device-discovery-rules/{*ID}/device-targets/device-fingerprints.
@totalIntegerYY N Total number of gen_device-discovery-rule-device-targets-device-targets-device-fingerprints in the API result set. If paging parameters are used in the query to limit the result set size, then total represents the total number of gen_device-discovery-rule-device-targets-device-targets-device-fingerprints in all the pages of the result set.
device-fingerprintdevice-discovery-rule.deviceTargets.deviceTarget.deviceFingerprints.deviceTargetFingerprint[]NY Y  

device-discovery-rule.deviceTargets.deviceTarget.deviceFingerprints.deviceTargetFingerprint

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)YY N NNLink to this deviceTargetFingerprint node in the current node context. This link can be used to retrieve or operate on the currently referenced deviceTargetFingerprint in the tree path.
host-nameStringNY Y * NNName of the node.
idIntegerYY N NNId of the finger print entity.
fingerprintStringNY Y * NNdevice fingerprint.

device-discovery-rule.deviceSnmpDetail

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this deviceSnmpDetail node in the current node context. This link can be used to retrieve or operate on the currently referenced deviceSnmpDetail in the tree path.
snmpv1v2c-communityStringNY Y * SNMPV1/V2C Community name.
user-nameStringNY Y * SNMPV3 username.
snmp-auth-typeenum(snmp-auth-type)NY Y * Authentication type of SNMPv3 Possible values : MD5, SHA1 or NONE;.

Possible Values:
MD5 
SHA1 
NONE 
.
authentication-passwordStringNY Y * Password for SNMPv3 authentication.
privacy-typeenum(privacy-type)NY Y * Encryption methods to be used while discovery Possible values: AES128, AES192, AES256, DES or NONE.

Possible Values:
AES128 
AES192 
AES256 
DES 
NONE 
.
idIntegerNY Y Device SNMP details id.
privacy-passwordStringNY Y * key word to be used for encryption.

device-discovery-rule.discoveryActionParams

Discovery Action additional parameter configuration

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this discoveryActionParams node in the current node context. This link can be used to retrieve or operate on the currently referenced discoveryActionParams in the tree path.
discovery-action-additional-paramdevice-discovery-rule.discoveryActionParams.discoveryTriggerActionParam[]NY Y * Discovery Action additional parameter.

device-discovery-rule.discoveryActionParams.discoveryTriggerActionParam

Discovery Action additional parameter

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)YY N NNLink to this discoveryTriggerActionParam node in the current node context. This link can be used to retrieve or operate on the currently referenced discoveryTriggerActionParam in the tree path.
parameterStringNY Y * NNParameter will act as a key.
parameter-valueStringNY Y * NNParameterValue will act as a value for the key.

Device-discovery-rule_patch (vnd.net.juniper.space.device-management.device-discovery-rule_patch;version=6)

device-discovery-rules (vnd.net.juniper.space.device-management.device-discovery-rules;version=6)

Field NameTypeRead OnlyGETPUT / POSTPATCHDescription
@uriString(URI)YY N NLink to this device-discovery-rules node in the current node context. This link can be used to retrieve or operate on the currently referenced device-discovery-rules in the tree path.
@totalIntegerYY N NTotal number of device-discovery-rules in the API result set. If paging parameters are used in the query to limit the result set size, then total represents the total number of device-discovery-rules in all the pages of the result set.
device-discovery-ruledevice-discovery-rules.deviceDiscoveryRule[]NY Y * Y 

device-discovery-rules.deviceDiscoveryRule

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@hrefString(URI)YY N NNLink to an external device-discovery-rule. Here, href points to the device-discovery-rule in the primary device-discovery-rules collection.

Hyperlink Template: /api/space/device-management/device-discovery-rules/{*ID}.
idIntegerYY N YYDeviceDiscoveryRule ID.
discovery-profile-nameStringNY Y YYDiscovery Profile Name.
discovery-typeenum(discovery-type)NY Y YYDiscovery type (i.e) IP_ADDRESS, IP_RANGE, IP-SUBNET, HOSTNAME and IMPORT_BY_CSV.

Possible Values:
IMPORT_BY_CSVIMPORT BY CSV
HOSTNAME 
IP_ADDRESSIP ADDRESS
IP_RANGEIP RANGE
IP_SUBNETIP SUBNET
IP_HOSTNAMEIP HOSTNAME

Default: IP_ADDRESS.
sharableBooleanNY Y NNProfile sharable status.

Default: true.
profile-ownerStringNY Y NNProfile owner.
discovery-job-detailsdevice-discovery-rules.deviceDiscoveryRule.monitorableTaskInstanceManagedObjectNY Y NN 
target-detailsStringNY Y YYTarget details (10.155.60.1, 10.155.60.1-10.155.60.10, 10.155.60.1/24, Sunnyvale-ISG, sample_discovery.csv).
device-snmp-versionenum(device-snmp-version)NY Y YYSNMP version.

Possible Values:
NOT_APPLICABLEN/A
SNMPV1V2C 
SNMPV3 
.
device-targetsdevice-discovery-rules.deviceDiscoveryRule.deviceTargetsNY Y * NN 
domain-nameStringYY N NNDomain Name.
domain-idIntegerYY N NYDomain ID.

device-discovery-rules.deviceDiscoveryRule.monitorableTaskInstanceManagedObject

Field NameTypeRead OnlyGETPUT / POSTDescription
@hrefString(URI)NY Y * Link to an external monitorableTaskInstanceManagedObject. Here, href points to the monitorableTaskInstanceManagedObject in the primary monitorableTaskInstanceManagedObject collection.

Hyperlink Template: /api/space/job-management/jobs/{*ID}.
idIntegerYY N MonitorableTaskInstanceManagedObject ID.
nameStringYY N MonitorableTaskInstanceManagedObject Name.
scheduled-start-time-stringStringYY N Scheduled Start Time String REST.
schedule-stringStringYY N Schedule String.

device-discovery-rules.deviceDiscoveryRule.deviceTargets

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this deviceTargets node in the current node context. This link can be used to retrieve or operate on the currently referenced deviceTargets in the tree path.

Hyperlink Template: /api/space/device-management/device-discovery-rules/{*ID}/device-targets.
@totalIntegerYY N Total number of gen_device-discovery-rules-device-discovery-rules-device-targets in the API result set. If paging parameters are used in the query to limit the result set size, then total represents the total number of gen_device-discovery-rules-device-discovery-rules-device-targets in all the pages of the result set.
device-targetdevice-discovery-rules.deviceDiscoveryRule.deviceTargets.deviceTarget[]NY Y *  

device-discovery-rules.deviceDiscoveryRule.deviceTargets.deviceTarget

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)YY N NNLink to this deviceTarget node in the current node context. This link can be used to retrieve or operate on the currently referenced deviceTarget in the tree path.
idIntegerYY N NNId of device Target.
device-ssh-credentialsdevice-discovery-rules.deviceDiscoveryRule.deviceTargets.deviceTarget.deviceSshCredentialsNY Y NN 

device-discovery-rules.deviceDiscoveryRule.deviceTargets.deviceTarget.deviceSshCredentials

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this deviceSshCredentials node in the current node context. This link can be used to retrieve or operate on the currently referenced deviceSshCredentials in the tree path.

Hyperlink Template: /api/space/device-management/device-discovery-rules/{*ID}/device-targets/device-ssh-credentials.
@totalIntegerYY 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. If paging parameters are used in the query to limit the result set size, then total represents the total number of gen_device-discovery-rules-device-discovery-rules-device-discovery-rules-device-targets-device-targets-device-ssh-credentials in all the pages of the result set.
device-ssh-credentialdevice-discovery-rules.deviceDiscoveryRule.deviceTargets.deviceTarget.deviceSshCredentials.deviceSshCredential[]NY Y *  

device-discovery-rules.deviceDiscoveryRule.deviceTargets.deviceTarget.deviceSshCredentials.deviceSshCredential

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)YY N NNLink to this deviceSshCredential node in the current node context. This link can be used to retrieve or operate on the currently referenced deviceSshCredential in the tree path.
idIntegerYY N NNDevice credential id.
usernameStringNY Y * NNName of user on the node used for authentication while discovery.
keybasedBooleanNY Y * NNTrue to enable key-based authentication. Password not need if this is true.

Default: false.
credential-typeenum(credential-type)NY Y NNCredential Type.

Possible Values:
CREDENTIAL_BASEDCredential Based
KEY_BASEDKey Based
CUSTOM_KEY_BASEDCustom Key Based
.
pass-phraseStringNY Y NNPass Phrase.
private-keyStringNY Y NNPrivate Key.

Device-discovery-rules_patch (vnd.net.juniper.space.device-management.device-discovery-rules_patch;version=6)

device-refs (vnd.net.juniper.space.device-management.modeled-device-management.device-refs;version=1)

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this device-refs node in the current node context. This link can be used to retrieve or operate on the currently referenced device-refs in the tree path.
@totalIntegerYY N Total number of devices in the API result set. If paging parameters are used in the query to limit the result set size, then total represents the total number of devices in all the pages of the result set.
devicedevice-refs.device[]NY Y * Modeled device which contains details like device-name, platform, os-version, serial-number.

device-refs.device

Modeled device which contains details like device-name, platform, os-version, serial-number

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@hrefString(URI)NY Y * NNLink to an external device. Here, href points to the device in the primary device collection.

Hyperlink Template: /api/space/device-management/devices/{*ID}.
@uriString(URI)YY N NNLink to this device node in the current node context. This link can be used to retrieve or operate on the currently referenced device in the tree path.

Hyperlink Template: /api/space/device-management/modeled-device-management/modeled-instances/{*ID}/devices.
idIntegerYY N YYId of the device.
nameStringYY N YYName of the device.
os-versionStringYY N YYOS version of the device.
platformStringYY N YYPlatform of the device.
serial-numberStringYY N YYSerial Number of the device.
statusStringYY N YYStatus of the device.
managed-statusStringYY N YYManaged status of the device.
ip-addrStringYY N YYIP Address of the device.

devices (vnd.net.juniper.space.device-management.devices;version=1)

The 'devices' resource model represents a view of all the device resources in the system. It consists of the the following fields:

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)NY Y * Link to this devices node in the current node context. This link can be used to retrieve or operate on the currently referenced devices in the tree path.
@sizeIntegerNY Y * Total number of devices.
devicedevices.device[]NY Y A collection of devices. Each object in the collection refers to a device.

devices.device

The 'device' field of type 'device' represents the pull-through data for a device. It consists of the the following fields:

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@hrefString(URI)NY Y * NNLink to an external device. Here, href points to the device in the primary device collection.
@uriString(URI)NY Y * NNLink to this device node in the current node context. This link can be used to retrieve or operate on the currently referenced device in the tree path.
@keyIntegerNY Y * YY Unique identifier for the 'device'.
deviceFamilyStringNY Y YY Device family that the device belongs to (for example, MX)
OSVersionStringNY Y NN OS version of the device
platformStringNY Y YY Platform of the device
serialNumberStringNY Y YY Serial number of the device
connectionStatusStringNY Y YY Active connection status of the device
ipAddrStringNY Y YY IP address of the device
managedStatusStringNY Y YY Managed status of the device
device-idintNY Y NN Unique Identifier of Device
web-mgmtStringNY Y NN Web management protocol
lsys-countintNY Y NN Device Lsys Count
rootLsysDeviceDONY Y NN Device Lsys Root
hosting-deviceIdintNY Y NN Hosting Device ID
authentication-statusenum(authentication-status)NY Y NN Authentication status of the Device

Possible Values:
CREDENTIALCredentials Based
RSA_KEYKey Based
KEY_CONFLICTKey Conflict
NOT_AVAILABLENA
CREDENTIAL_UNVERIFIEDCredentials Based - Unverified
RSA_KEY_UNVERIFIEDKey Based - Unverified
KEY_CONFLICT_UNVERIFIEDKey Conflict - Unverified
FINGER_PRINT_CONFLICTFingerprint Conflict
CUSTOM_KEYCustom Key Based
CUSTOM_KEY_UNVERIFIEDCustom Key - Unverified
connection-typeStringNY Y NN Connection type of the Device
adapter-nameStringNY Y NN Name of the Adapter used for Device discovery
nameStringNY Y YY Name of the device
domain-idIntegerNY Y NY domain id of device.
domain-nameStringNY Y NN domain name of the device.
config-statusenum(config-status)NY Y NN Config Status

Possible Values:
DEVICE_STATE_AWAIT_1STCONNIMConnecting
DEVICE_STATE_IN_SYNCIn Sync
DEVICE_STATE_UNDEFNone
DEVICE_STATE_OUT_OF_SYNCOut Of Sync
DEVICE_STATE_SYNC_FAILEDSync Failed
DEVICE_STATE_SYNCHRONIZINGSynchronizing
DEVICE_STATE_MODELEDModeled
DEVICE_STATE_IN_RMAIn RMA
DEVICE_STATE_RMA_REACTIVATINGReactivating
DEVICE_STATE_RMA_REACTIVATE_FAILEDReactivate Failed
DEVICE_STATE_SSOR_UNDEFUndefined
DEVICE_STATE_SSOR_UNKNOWNUnknown
DEVICE_STATE_SSOR_IN_SYNCIn Sync
DEVICE_STATE_SSOR_SPACE_CHANGEDSpace Changed
DEVICE_STATE_SSOR_DEVICE_CHANGEDDevice Changed
DEVICE_STATE_SSOR_BOTH_CHANGEDSpace & Device Changed
DEVICE_STATE_UNMANAGEDUnmanaged
DEVICE_STATE_ACTIVATEDWaiting for Deployment
device-typeenum(device-type)NY Y NNDevice Type.

Possible Values:
LSYS 
ROOT 

devices (vnd.net.juniper.space.device-management.devices;version=1)

The 'devices' resource model represents a view of all the device resources in the system. It consists of the the following fields:

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)NY Y * Link to this devices node in the current node context. This link can be used to retrieve or operate on the currently referenced devices in the tree path.
@sizeIntegerNY Y * Total number of devices.
devicedevices.device[]NY Y A collection of devices. Each object in the collection refers to a device.

devices.device

The 'device' field of type 'device' represents the pull-through data for a device. It consists of the the following fields:

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@hrefString(URI)NY Y * NNLink to an external device. Here, href points to the device in the primary device collection.
@uriString(URI)NY Y * NNLink to this device node in the current node context. This link can be used to retrieve or operate on the currently referenced device in the tree path.
@keyIntegerNY Y * YY Unique identifier for the 'device'.
deviceFamilyStringNY Y YY Device family that the device belongs to (for example, MX)
OSVersionStringNY Y NN OS version of the device
platformStringNY Y YY Platform of the device
serialNumberStringNY Y YY Serial number of the device
connectionStatusStringNY Y YY Active connection status of the device
ipAddrStringNY Y YY IP address of the device
managedStatusStringNY Y YY Managed status of the device
device-idintNY Y * NN Unique Identifier of Device
web-mgmtStringNY Y NN Web Management protocol
lsys-countintNY Y * NN Device Lsys Count
rootLsysDeviceDONY Y NN Device Lsys Root
hosting-deviceIdintNY Y * NN Hosting Device ID
authentication-statusenum(authentication-status)NY Y NN Authentication status of the Device

Possible Values:
CREDENTIALCredentials Based
RSA_KEYKey Based
KEY_CONFLICTKey Conflict
NOT_AVAILABLENA
CREDENTIAL_UNVERIFIEDCredentials Based - Unverified
RSA_KEY_UNVERIFIEDKey Based - Unverified
KEY_CONFLICT_UNVERIFIEDKey Conflict - Unverified
FINGER_PRINT_CONFLICTFingerprint Conflict
CUSTOM_KEYCustom Key Based
CUSTOM_KEY_UNVERIFIEDCustom Key - Unverified
connection-typeStringNY Y NN Connection type of the Device
adapter-nameStringNY Y NN Name of the Adapter used for Device discovery
nameStringNY Y YY Name of the device
domain-idIntegerNY Y NY domain id of device.
domain-nameStringNY Y NN domain name of the device.
config-statusenum(config-status)NY Y NN Config Status

Possible Values:
DEVICE_STATE_AWAIT_1STCONNIMConnecting
DEVICE_STATE_IN_SYNCIn Sync
DEVICE_STATE_UNDEFNone
DEVICE_STATE_OUT_OF_SYNCOut Of Sync
DEVICE_STATE_SYNC_FAILEDSync Failed
DEVICE_STATE_SYNCHRONIZINGSynchronizing
DEVICE_STATE_MODELEDModeled
DEVICE_STATE_IN_RMAIn RMA
DEVICE_STATE_RMA_REACTIVATINGReactivating
DEVICE_STATE_RMA_REACTIVATE_FAILEDReactivate Failed
DEVICE_STATE_SSOR_UNDEFUndefined
DEVICE_STATE_SSOR_UNKNOWNUnknown
DEVICE_STATE_SSOR_IN_SYNCIn Sync
DEVICE_STATE_SSOR_SPACE_CHANGEDSpace Changed
DEVICE_STATE_SSOR_DEVICE_CHANGEDDevice Changed
DEVICE_STATE_SSOR_BOTH_CHANGEDSpace & Device Changed
DEVICE_STATE_UNMANAGEDUnmanaged
DEVICE_STATE_ACTIVATEDWaiting for Deployment
device-typeenum(device-type)NY Y NNDevice Type.

Possible Values:
LSYS 
ROOT 
attribute-column-0StringNY Y YYCustom Attribute for Device.
use-natbooleanNY Y YYAn attribute that describes the device is connected to NAT or not.
fingerprintStringNY Y NN 
newFingerprintStringNY Y NN 

devices (vnd.net.juniper.space.domain-management.devices;version=3)

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this devices node in the current node context. This link can be used to retrieve or operate on the currently referenced devices in the tree path.
@totalIntegerYY N Total number of devices in the API result set. If paging parameters are used in the query to limit the result set size, then total represents the total number of devices in all the pages of the result set.
devicedevices.device[]NY Y *  

devices.device

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@hrefString(URI)NY Y * NNLink to an external device. Here, href points to the device in the primary device collection.

Hyperlink Template: /api/space/device-management/devices/{*ID}.
os-versionStringYY N YYOS Version.
device-nameStringYY N YYDevice Name.
managed-statusStringYY N YYManaged Status.
platformStringYY N YYPlatform.
domain-idIntegerYY N NYDomain ID.
idIntegerYY N YYDevice ID.
nameStringYY N YYDevice Name.
ip-addressStringYY N YYIP Address.

devices-by-templates2 (vnd.net.juniper.space.config-template-management.devices-by-templates2;version=2)

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this devices-by-templates2 node in the current node context. This link can be used to retrieve or operate on the currently referenced devices-by-templates2 in the tree path.
@totalIntegerYY N Total number of devices-by-templates2 in the API result set. If paging parameters are used in the query to limit the result set size, then total represents the total number of devices-by-templates2 in all the pages of the result set.
device-templatedevices-by-templates2.deviceTemplate[]NY Y *  

devices-by-templates2.deviceTemplate

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)YY N NNLink to this deviceTemplate node in the current node context. This link can be used to retrieve or operate on the currently referenced deviceTemplate in the tree path.
attribute-column0StringNY Y * YYAttribute Column0.
software-releaseStringNY Y * YYSoftware Release.
OSVersionStringNY Y YYOS Version.
connectionStatusStringNY Y YYConnection Status.
ipAddrStringNY Y YYIP Addr.
platformStringNY Y * YYPlatform.
original-platformStringNY Y * NNOriginal Platform.
statusStringNY Y * YYStatus.
templateVerIntegerNY Y * NNTemplate Ver.
managedStatusStringNY Y YYManaged Status.
idIntegerYY N YYDeviceTemplate ID.
nameStringNY Y * YYDeviceTemplate Name.
config-statusenum(config-status)NY Y * NNConfig Status.

Possible Values:
DEVICE_STATE_AWAIT_1STCONNIMConnecting
DEVICE_STATE_IN_SYNCIn Sync
DEVICE_STATE_UNDEFNone
DEVICE_STATE_OUT_OF_SYNCOut Of Sync
DEVICE_STATE_SYNC_FAILEDSync Failed
DEVICE_STATE_SYNCHRONIZINGSynchronizing
DEVICE_STATE_MODELEDModeled
DEVICE_STATE_IN_RMAIn RMA
DEVICE_STATE_RMA_REACTIVATINGReactivating
DEVICE_STATE_RMA_REACTIVATE_FAILEDReactivate Failed
DEVICE_STATE_SSOR_UNDEFUndefined
DEVICE_STATE_SSOR_UNKNOWNUnknown
DEVICE_STATE_SSOR_IN_SYNCIn Sync
DEVICE_STATE_SSOR_SPACE_CHANGEDSpace Changed
DEVICE_STATE_SSOR_DEVICE_CHANGEDDevice Changed
DEVICE_STATE_SSOR_BOTH_CHANGEDSpace & Device Changed
DEVICE_STATE_UNMANAGEDUnmanaged
DEVICE_STATE_ACTIVATEDWaiting for Deployment
.
device-familyStringNY Y * YYDevice Family.
domain-nameStringNY Y NNDomain Name.

disable-user (vnd.net.juniper.space.user-management.disable-user;version=3)

Field NameTypeRead OnlyGETPUT / POSTDescription
valueStringNY Y * Value.

disable-users-request (vnd.net.juniper.space.user-management.disable-users-request;version=3)

Field NameTypeRead OnlyGETPUT / POSTDescription
usersdisable-users-request.usersNY Y *  

disable-users-request.users

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this users node in the current node context. This link can be used to retrieve or operate on the currently referenced users in the tree path.
userdisable-users-request.users.user[]NY Y * Get all users.

disable-users-request.users.user

Get all users

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@hrefString(URI)NY Y * NNLink to an external user. Here, href points to the user in the primary users collection.

Hyperlink Template: /api/space/user-management/users/{*ID}.
idIntegerYY N YYUser ID.
nameStringYY N YYUser Name.

discover-devices (vnd.net.juniper.space.device-management.discover-devices;version=2)

The 'discover-devices' resource model consists of the following fields:

Field NameTypeRead OnlyGETPUT / POSTDescription
discoveryMethodsDiscoveryTarget[]NY Y Discovery target schemes
usePingBooleanNY Y A flag for using ping
useSnmpBooleanNY Y A flag for using SNMP
snmpSettingsSnmpSetting[]NY Y SNMP setting schemes
manageDiscoveredSystemsFlagBooleanNY Y A flag to manage the discovery system
credentialsCredential[]NY Y List of credentials for testing the connectivity of the discovered system. The credentials are tried on the discovered system one by one until a credential is successful or all of the credentials fail.
device-fingerprintsDeviceFingerprintsNY Y  

discover-devices-request (vnd.net.juniper.space.device-management.discover-devices-request;version=6)

Field NameTypeRead OnlyGETPUT / POSTDescription
device-discovery-rulesdiscover-devices-request.deviceTargetRulesNY Y *  

discover-devices-request.deviceTargetRules

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this deviceTargetRules node in the current node context. This link can be used to retrieve or operate on the currently referenced deviceTargetRules in the tree path.
device-discovery-rulediscover-devices-request.deviceTargetRules.deviceDiscoveryRule[]NY Y *  

discover-devices-request.deviceTargetRules.deviceDiscoveryRule

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@hrefString(URI)NY Y * NNLink to an external device-discovery-rule. Here, href points to the device-discovery-rule in the primary device-discovery-rules collection.

Hyperlink Template: /api/space/device-management/device-discovery-rules/{*ID}.
idIntegerYY N YYDeviceDiscoveryRule ID.

discovery-job-results (vnd.net.juniper.space.device-management.discovery-job-results;version=6)

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this discovery-job-results node in the current node context. This link can be used to retrieve or operate on the currently referenced discovery-job-results in the tree path.
@totalIntegerYY N Total number of discovery-job-results in the API result set. If paging parameters are used in the query to limit the result set size, then total represents the total number of discovery-job-results in all the pages of the result set.
system-discovery-resultdiscovery-job-results.systemDiscoveryResult[]NY Y *  

discovery-job-results.systemDiscoveryResult

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)YY N NNLink to this systemDiscoveryResult node in the current node context. This link can be used to retrieve or operate on the currently referenced systemDiscoveryResult in the tree path.
idIntegerYY N NNJob result table row ID.
discovery-fail-reasonStringNY Y * YYIf the system fails to be discovered or managed by JMP, set the fail reason.
vendor-nameStringNY Y * YNVendor Name.
system-discovery-statusenum(system-discovery-status)NY Y * YYSystem discovery status.

Possible Values:
ADD_DEVICE_FAILEDAdd Device failed
ALREADY_MANAGEDAlready Managed
ADD_DEVICE_SUCCEEDEDDevice Managed
DISCOVER_SUCCEEDEDDiscovery succeeded
SYNC_DEVICE_FAILEDJunospace Manageable Device but Sync failed
ADD_DEVICE_TIMEDOUTJunospace Manageable Device but Timed out
NOT_DISCOVEREDSkipped
CANCELLEDCancelled
.
hostnameStringNY Y YYHostname.
device-idIntegerNY Y YYDevice Id.
serial-numStringNY Y NNSerial Num.
ipStringNY Y * YYScanned ip.

discoveryresult (vnd.net.juniper.space.device-management.discoveryresult;version=1)

The 'discoveryresult' resource model represents a view of the information about the device discovery results. It consists of the following fields:

Field NameTypeRead OnlyGETPUT / POSTDescription
@sizeIntegerNY Y * Total number of results.
discoveryresultSystemDiscoveryResult[]NY Y * A collection of results. Each object in the collection represents a result.

domain (vnd.net.juniper.space.domain-management.domain;version=1)

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this domain node in the current node context. This link can be used to retrieve or operate on the currently referenced domain in the tree path.

Hyperlink Template: /api/space/domain-management/domains/{*ID}.
@hrefString(URI)YY N Link to an external domain. Here, href points to the domain in the primary domain collection.

Hyperlink Template: /api/space/domain-management/domains/{*ID}.
write-enabledBooleanYY N If true then user has read and write access to the domain else user has either read only or no access.

Default: false.
*idIntegerYY N ID of domain.
child-countIntegerYY N The number of immediate children for this domain.
modified-atStringYY N The time this domain was last modified at.
created-atStringYY N Time the domain was created.
descriptionStringNY Y Description added by user.
parentdomain.domain_REFNY Y The parent domain of this domain.
nameStringNY Y * Name of the domain.
childrendomain.domain_REFsYY N List of sub domain of the domain.
child-lockBooleanNY Y * If set to true the domain does not allow read and execute access to it's parent domain objects.

Default: false.
domain-typeenum(domain-type)NY Y Domain Type.

Possible Values:
SYSTEMSystem
GLOBALGlobal
CUSTOMCustom

Default: CUSTOM.
no-of-assigned-devicesIntegerNY Y No Of Assigned Devices.
no-of-assigned-usersIntegerNY Y No Of Assigned Users.
no-of-assigned-remote-profileIntegerNY Y No Of Assigned Remote Profile.
usersStringYY N List of users assigned to the domain

Hyperlink Template: /api/space/domain-management/domains/{*ID}/users.
profilesStringYY N List of remote profiles assigned to the domain

Hyperlink Template: /api/space/domain-management/domains/{*ID}/profiles.
devicesStringYY N Assign Devices to the Domain

Hyperlink Template: /api/space/domain-management/domains/{*ID}/devices.

domain.domain_REF

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this domain node in the current node context. This link can be used to retrieve or operate on the currently referenced domain in the tree path.

Hyperlink Template: /api/space/domain-management/domains/{*ID}.
@hrefString(URI)NY Y * Link to an external domain_REF. Here, href points to the domain_REF in the primary domain_REF collection.

Hyperlink Template: /api/space/domain-management/domains/{*ID}.
idIntegerYY N ID of domain.
nameStringNY Y Name of the domain.

domain.domain_REFs

List of subdomain of the domain

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this domains node in the current node context. This link can be used to retrieve or operate on the currently referenced domains in the tree path.

Hyperlink Template: /api/space/domain-management/domains/{*ID}/children.
domaindomain.domain_REFs.domain_REF[]NY Y *  

domain.domain_REFs.domain_REF

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@hrefString(URI)NY Y * NNLink to an external domain_REF. Here, href points to the domain_REF in the primary domain_REF collection.

Hyperlink Template: /api/space/domain-management/domains/{*ID}.
@uriString(URI)YY N NNLink to this domain node in the current node context. This link can be used to retrieve or operate on the currently referenced domain in the tree path.

Hyperlink Template: /api/space/domain-management/domains/{*ID}/children/{*ID}.
idIntegerYY N NNID of domain.
nameStringYY N NNName of the domain.
child-countIntegerYY N NNThe number of immediate children for this domain.
created-atStringYY N NNTime the domain was created.
descriptionStringYY N YNDescription added by user.
write-enabledBooleanYY N NNIf true then user has read and write access to the domain else user has either read only or no access.

Default: false.
child-lockBooleanYY N NNIf set to true the domain does not allow read and execute access to it's parent domain objects.

Default: false.
domain-typeenum(domain-type)NY Y NNDomain Type.

Possible Values:
SYSTEMSystem
GLOBALGlobal
CUSTOMCustom

Default: CUSTOM.
no-of-assigned-devicesIntegerYY N NNNo Of Assigned Devices.
no-of-assigned-usersIntegerYY N NNNo Of Assigned Users.
no-of-assigned-remote-profileIntegerYY N NNNo Of Assigned Remote Profile.

domain-children (vnd.net.juniper.space.domain-management.domain-children;version=2)

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this domain-children node in the current node context. This link can be used to retrieve or operate on the currently referenced domain-children in the tree path.

Hyperlink Template: /api/space/domain-management/domains/{*ID}/children/{*ID}.
@hrefString(URI)YY N Link to an external domain-children. Here, href points to the domain-children in the primary domains collection.

Hyperlink Template: /api/space/domain-management/domains/{*ID}.
*idIntegerNY Y * ID of domain.
nameStringNY Y * Name of the domain.
descriptionStringNY Y * Description added by user.

domains (vnd.net.juniper.space.domain-management.domains;version=1)

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this domains node in the current node context. This link can be used to retrieve or operate on the currently referenced domains in the tree path.
@totalIntegerYY N Total number of domains in the API result set. If paging parameters are used in the query to limit the result set size, then total represents the total number of domains in all the pages of the result set.
domaindomains.domain[]NY Y *  

domains.domain

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@hrefString(URI)NY Y NNLink to an external domain. Here, href points to the domain in the primary domain collection.

Hyperlink Template: /api/space/domain-management/domains/{*ID}.
@uriString(URI)YY N NNLink to this domain node in the current node context. This link can be used to retrieve or operate on the currently referenced domain in the tree path.

Hyperlink Template: /api/space/domain-management/domains/{*ID}.
idIntegerYY N NNID of domain.
created-atStringYY N NNTime the domain was created.
modified-atStringYY N NNTime the domain was last modified.
descriptionStringNY Y NNDescription added by user.
nameStringNY Y * NNName of the domain.
childrendomains.domain.domain_REFsYY N NNList of sub domain of the domain.
child-lockBooleanNY Y * NN 

Default: false.
domain-typeenum(domain-type)NY Y NNDomain Type.

Possible Values:
SYSTEMSystem
GLOBALGlobal
CUSTOMCustom

Default: CUSTOM.

domains.domain.domain_REFs

List of subdomain of the domain

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this domains node in the current node context. This link can be used to retrieve or operate on the currently referenced domains in the tree path.

Hyperlink Template: /api/space/domain-management/domains/{*ID}/children.
domaindomains.domain.domain_REFs.domain_REF[]NY Y *  

domains.domain.domain_REFs.domain_REF

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)YY N NNLink to this domain node in the current node context. This link can be used to retrieve or operate on the currently referenced domain in the tree path.

Hyperlink Template: /api/space/domain-management/domains/{*ID}/children/{*ID}.
@hrefString(URI)NY Y NNLink to an external domain_REF. Here, href points to the domain_REF in the primary domain_REF collection.

Hyperlink Template: /api/space/domain-management/domains/{*ID}.
idIntegerYY N NNID of domain.
nameStringNY Y * NNName of the domain.

domains (vnd.net.juniper.space.domain-management.domains;version=2)

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this domains node in the current node context. This link can be used to retrieve or operate on the currently referenced domains in the tree path.
@totalIntegerYY N Total number of domains in the API result set. If paging parameters are used in the query to limit the result set size, then total represents the total number of domains in all the pages of the result set.
domaindomains.domain[]NY Y *  

domains.domain

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)YY N NNLink to this domain node in the current node context. This link can be used to retrieve or operate on the currently referenced domain in the tree path.

Hyperlink Template: /api/space/domain-management/domains/{*ID}.
@hrefString(URI)YY N NNLink to an external domain. Here, href points to the domain in the primary domains collection.

Hyperlink Template: /api/space/domain-management/domains/{*ID}.
idIntegerYY N NNDomain ID.
nameStringYY N YYDomain Name.
childrendomains.domain.domain_REFsYY N NN 
child-countIntegerYY N NNChild Count.
child-lockBooleanYY N NNChild Lock.

Default: false.
domain-typeenum(domain-type)NY Y NNDomain Type.

Possible Values:
SYSTEMSystem
GLOBALGlobal
CUSTOMCustom

Default: CUSTOM.

domains.domain.domain_REFs

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this domains node in the current node context. This link can be used to retrieve or operate on the currently referenced domains in the tree path.

Hyperlink Template: /api/space/domain-management/domains/{*ID}/children.
@totalIntegerYY N Total number of gen_domains-domains-children in the API result set. If paging parameters are used in the query to limit the result set size, then total represents the total number of gen_domains-domains-children in all the pages of the result set.
domaindomains.domain.domain_REFs.domain_REF[]NY Y *  

domains.domain.domain_REFs.domain_REF

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)YY N NNLink to this domain node in the current node context. This link can be used to retrieve or operate on the currently referenced domain in the tree path.

Hyperlink Template: /api/space/domain-management/domains/{*ID}/children/{*ID}.
@hrefString(URI)YY N NNLink to an external domain_REF. Here, href points to the domain_REF in the primary domains collection.

Hyperlink Template: /api/space/domain-management/domains/{*ID}.
child-countIntegerYY N NNChild Count.
idIntegerYY N NNDomain ID.
nameStringYY N YNDomain Name.
child-lockBooleanYY N NNChild Lock.

Default: false.

enable-user (vnd.net.juniper.space.user-management.enable-user;version=3)

Field NameTypeRead OnlyGETPUT / POSTDescription
valueStringNY Y * Value.

enable-users-request (vnd.net.juniper.space.user-management.enable-users-request;version=3)

Field NameTypeRead OnlyGETPUT / POSTDescription
usersenable-users-request.usersNY Y *  

enable-users-request.users

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this users node in the current node context. This link can be used to retrieve or operate on the currently referenced users in the tree path.
userenable-users-request.users.user[]NY Y * Get all users.

enable-users-request.users.user

Get all users

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@hrefString(URI)NY Y * NNLink to an external user. Here, href points to the user in the primary users collection.

Hyperlink Template: /api/space/user-management/users/{*ID}.
idIntegerYY N YYUser ID.
nameStringYY N YYUser Name.

equipment-holder (vnd.net.juniper.space.managed-domain.equipment-holder;version=2)

The 'equipment-holder' resource model contains information about a single equipment holder. It consists of the following fields:

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)NY Y NNLink to this equipment-holder node in the current node context. This link can be used to retrieve or operate on the currently referenced equipment-holder in the tree path.
idIntegerNY Y * NN The ID of the equipment holder
nameStringNY Y NN The name of the holder
pathStringNY Y NN The location of the element in the managed element
aliasStringNY Y NN An alias for the equipment holder
containedEquipmentequipment-holder[]NY Y NN The equipment and equipment holders directly contained by this holder
holderTypeStringNY Y NN The current type of the equipment holder with respect to the contained equipment
holderStateStringNY Y NN The current condition of the equipment holder with respect to the contained equipment
expectedOrInstalledEquipmentJSEquipmentNY Y NN The equipment that is installed or is expected to be installed in the physical container represented by the equipment holder

equipment-holder (vnd.net.juniper.space.managed-domain.equipment-holder;version=2)

The 'equipment-holder' resource model contains information for a single equipment holder. It consists of the following fields:

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)NY Y NNLink to this equipment-holder node in the current node context. This link can be used to retrieve or operate on the currently referenced equipment-holder in the tree path.
idIntegerNY Y * NN The ID of the equipment holder
nameStringNY Y NN The name of equipment holder
pathStringNY Y NN The location of the equipment holder in the managed element
aliasStringNY Y NN An alias for the equipment holder
containedEquipmentequipment-holder[]NY Y NN The equipment and equipment holders directly contained by this holder
holderTypeStringNY Y NN The current type of the equipment holder with respect to the contained equipment
holderStateStringNY Y NN The current condition of the equipment holder with respect to the contained equipment
expectedOrInstalledEquipmentJSEquipmentNY Y NN The equipment that is installed or is expected to be installed in the physical container represented by the equipment holder

equipment-holder (vnd.net.juniper.space.managed-domain.equipment-holder;version=1)

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this equipment-holder node in the current node context. This link can be used to retrieve or operate on the currently referenced equipment-holder in the tree path.

Hyperlink Template: /api/space/managed-domain/equipment-holders/{*ID}.
@hrefString(URI)YY N Link to an external equipment-holder. Here, href points to the equipment-holder in the primary equipment-holder collection.

Hyperlink Template: /api/space/managed-domain/equipment-holders/{*ID}.
child-countIntegerNY Y * Number of Child Equipment holder.
hosting-meequipment-holder.managedElementNY Y  
expected-or-installed-equipmentequipment-holder.equipmentNY Y *  
holder-typeenum(holder-type)NY Y * This attribute identifies the type of the Holder (Rack (or Bay), Shelf, Sub-shelf, Slot, Subslot, Remote-unit or Remote-subslot). This follows MTOSI.

Possible Values:
RACK 
SHELF 
SUB_SHELF 
BAY 
SLOT 
SUBSLOT 
PORT 
REMOTE_UNIT 
REMOTE_SUBSLOT 
.
contained-equipmentequipment-holder.equipmentHolder_REFsNY Y *  
*idIntegerYY N Object Id.
device-nameStringNY Y * Device Name.
domain-idIntegerNY Y Domain ID.
nameStringNY Y * EquipmentHolder Name.
pathStringNY Y * Path.
device-idIntegerNY Y * Device ID.
belong-toequipment-holder.equipmentHolder_REFNY Y  
domain-nameStringYY N Domain Name.
holder-stateenum(holder-state)NY Y * This attribute identifies the state of the Holder (Empty, Installed&Expected, Expected&NotInstalled, Installed&NotExpected, Mismatch, Unavailable or Unknown).

Possible Values:
EMPTY 
INSTALLED_AND_EXPECTED 
EXPECTED_AND_NOT_INSTALLED 
INSTALLED_AND_NOT_EXPECTED 
MISMATCH_OF_INSTALLED_AND_EXPECTED 
UNAVAILABLE 
UNKNOWN 
.
belong-to-idIntegerNY Y * Belong To ID.
display-nameStringNY Y Display Name.

equipment-holder.managedElement

Field NameTypeRead OnlyGETPUT / POSTDescription
@hrefString(URI)NY Y * Link to an external managedElement. Here, href points to the managedElement in the primary managedElement collection.

Hyperlink Template: /api/space/managed-domain/managed-elements/{*ID}.
idIntegerYY N Object Id.

equipment-holder.equipment

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this equipment node in the current node context. This link can be used to retrieve or operate on the currently referenced equipment in the tree path.
installed-equipment-object-typeStringYY N This attribute identifies the type of the installed resource. For example, "Fan" or "STM16" for the Equipment class and "Line Shelf" for the Equipment Holder class.) The installed equipment type is invariant for the lifetime of the hardware. This is an empty string if there is no expected equipment. This follows MTOSI.
expected-equipment-object-typeStringYY N This attribute identifies the type of the expected resource. For example, "Fan" or "STM16" for the Equipment class and "Line Shelf" for the Equipment Holder class.) This is an empty string if there is no expected equipment. This follows MTOSI.
installed-serial-numberStringYY N This is the serial number of the installed equipment. Unique, if no default is provided. At least one serialnumber has to be provided. This follows MTOSI.
installed-descriptionStringYY N This attribute gives a description of the installed equipment, if not available empty string shall be used. This information is available for junos based devices.
domain-nameStringYY N Domain Name.
manufacturerStringYY N The manufacturer attribute identifies the equipment manufacturer name. This attribute is defined as a non-empty free format string with no semantics. This follows MTOSI.
installed-vendor-part-numberStringYY N Installed Vendor Part Number.
display-nameStringYY N Display Name.
idStringYY N MOID.
installed-versionStringYY N This attribute identifies the resource version of the installed equipment, if not available empty string shall be used. This follows MTOSI.
installed-modelStringYY N Installed Model.
domain-idIntegerYY N Domain ID.
nameStringYY N Equipment Name.
device-idIntegerYY N Device ID.
installed-part-numberStringYY N This attribute identifies the resource Part Number (PN) of the installed equipment. If PN is not available empty string shall be used. If the part and serial number are both non-null then the part+serial number together shall be unique. This follows MTOSI.
installed-vendor-material-numberStringYY N Installed Vendor Material Number.
pathStringYY N Path.
comp-statusStringYY N Comp Status.

equipment-holder.equipmentHolder_REFs

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this equipmentHolders node in the current node context. This link can be used to retrieve or operate on the currently referenced equipmentHolders in the tree path.

Hyperlink Template: /api/space/managed-domain/equipment-holders/{*ID}/contained-equipment.
@totalIntegerYY N Total number of gen_equipment-holder-contained-equipment in the API result set. If paging parameters are used in the query to limit the result set size, then total represents the total number of gen_equipment-holder-contained-equipment in all the pages of the result set.
equipment-holderequipment-holder.equipmentHolder_REFs.equipmentHolder_REF[]NY Y *  

equipment-holder.equipmentHolder_REFs.equipmentHolder_REF

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@hrefString(URI)NY Y * NNLink to an external equipmentHolder_REF. Here, href points to the equipmentHolder_REF in the primary equipmentHolder_REF collection.

Hyperlink Template: /api/space/managed-domain/equipment-holders/{*ID}.
idIntegerYY N NNObject Id.

equipment-holder.equipmentHolder_REF

Field NameTypeRead OnlyGETPUT / POSTDescription
@hrefString(URI)NY Y Link to an external equipmentHolder_REF. Here, href points to the equipmentHolder_REF in the primary equipmentHolder_REF collection.

Hyperlink Template: /api/space/managed-domain/equipment-holders/{*ID}.
idIntegerYY N Object Id.
nameStringYY N EquipmentHolder Name.

equipment-holders (vnd.net.juniper.space.managed-domain.equipment-holders;version=1)

The 'equipment-holders' resource model contains information about a collection of equipment holders for a managed element. It is a complex type and consists of the following pull-through fields:

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)NY Y Link to this equipment-holders node in the current node context. This link can be used to retrieve or operate on the currently referenced equipment-holders in the tree path.
@sizeIntegerNY Y The URI for the collection of all equipment holders for a managed element
equipment-holderequipment-holders.equipmentHolderDTO[]NY 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

equipment-holders.equipmentHolderDTO

The 'equipment-holder' type contains information about a single equipment holder and a URI that gives all information accessible for this holder.

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@keyIntegerNY Y * NN The ID of equipment holder
@uriString(URI)NY Y NNLink to this equipmentHolderDTO node in the current node context. This link can be used to retrieve or operate on the currently referenced equipmentHolderDTO in the tree path.
idIntegerNY Y * NNThe ID of the managed element
nameStringNY Y NN The name of the equipment holder

equipment-holders (vnd.net.juniper.space.managed-domain.equipment-holders;version=1)

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this equipment-holders node in the current node context. This link can be used to retrieve or operate on the currently referenced equipment-holders in the tree path.
@totalIntegerYY N Total number of equipment-holders in the API result set. If paging parameters are used in the query to limit the result set size, then total represents the total number of equipment-holders in all the pages of the result set.
equipment-holderequipment-holders.equipmentHolder[]NY Y *  

equipment-holders.equipmentHolder

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)YY N NNLink to this equipmentHolder node in the current node context. This link can be used to retrieve or operate on the currently referenced equipmentHolder in the tree path.

Hyperlink Template: /api/space/managed-domain/equipment-holders/{*ID}.
@hrefString(URI)YY N NNLink to an external equipmentHolder. Here, href points to the equipmentHolder in the primary equipmentHolder collection.

Hyperlink Template: /api/space/managed-domain/equipment-holders/{*ID}.
child-countIntegerNY Y * NNNumber of Child Equipment holder.
hosting-meequipment-holders.equipmentHolder.managedElementNY Y NN 
expected-or-installed-equipmentequipment-holders.equipmentHolder.equipmentNY Y * NN 
holder-typeenum(holder-type)NY Y * NNThis attribute identifies the type of the Holder (Rack (or Bay), Shelf, Sub-shelf, Slot, Subslot, Remote-unit or Remote-subslot). This follows MTOSI.

Possible Values:
RACK 
SHELF 
SUB_SHELF 
BAY 
SLOT 
SUBSLOT 
PORT 
REMOTE_UNIT 
REMOTE_SUBSLOT 
.
idIntegerYY N NYObject Id.
belong-to-idIntegerNY Y * NNBelong To ID.
device-nameStringNY Y * NNDevice Name.
domain-idIntegerNY Y NYDomain ID.
nameStringNY Y * NNEquipmentHolder Name.
pathStringNY Y * NNPath.
device-idIntegerNY Y * NYDevice ID.
belong-toequipment-holders.equipmentHolder.equipmentHolder_REFNY Y NN 
domain-nameStringYY N NNDomain Name.
holder-stateenum(holder-state)NY Y * NNThis attribute identifies the state of the Holder (Empty, Installed&Expected, Expected&NotInstalled, Installed&NotExpected, Mismatch, Unavailable or Unknown).

Possible Values:
EMPTY 
INSTALLED_AND_EXPECTED 
EXPECTED_AND_NOT_INSTALLED 
INSTALLED_AND_NOT_EXPECTED 
MISMATCH_OF_INSTALLED_AND_EXPECTED 
UNAVAILABLE 
UNKNOWN 
.
display-nameStringNY Y NNDisplay Name.

equipment-holders.equipmentHolder.managedElement

Field NameTypeRead OnlyGETPUT / POSTDescription
@hrefString(URI)NY Y * Link to an external managedElement. Here, href points to the managedElement in the primary managedElement collection.

Hyperlink Template: /api/space/managed-domain/managed-elements/{*ID}.
idIntegerYY N Object Id.

equipment-holders.equipmentHolder.equipment

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this equipment node in the current node context. This link can be used to retrieve or operate on the currently referenced equipment in the tree path.
installed-equipment-object-typeStringYY N This attribute identifies the type of the installed resource. For example, "Fan" or "STM16" for the Equipment class and "Line Shelf" for the Equipment Holder class.) The installed equipment type is invariant for the lifetime of the hardware. This is an empty string if there is no expected equipment. This follows MTOSI.
expected-equipment-object-typeStringYY N This attribute identifies the type of the expected resource. For example, "Fan" or "STM16" for the Equipment class and "Line Shelf" for the Equipment Holder class.) This is an empty string if there is no expected equipment. This follows MTOSI.
installed-serial-numberStringYY N This is the serial number of the installed equipment. Unique, if no default is provided. At least one serialnumber has to be provided. This follows MTOSI.
installed-descriptionStringYY N This attribute gives a description of the installed equipment, if not available empty string shall be used. This information is available for junos based devices.
domain-nameStringYY N Domain Name.
installed-vendor-part-numberStringYY N Installed Vendor Part Number.
installed-versionStringYY N This attribute identifies the resource version of the installed equipment, if not available empty string shall be used. This follows MTOSI.
installed-modelStringYY N Installed Model.
domain-idIntegerYY N Domain ID.
nameStringYY N Equipment Name.
device-idIntegerYY N Device ID.
installed-part-numberStringYY N This attribute identifies the resource Part Number (PN) of the installed equipment. If PN is not available empty string shall be used. If the part and serial number are both non-null then the part+serial number together shall be unique. This follows MTOSI.
installed-vendor-material-numberStringYY N Installed Vendor Material Number.
pathStringYY N Path.
comp-statusStringYY N Comp Status.

equipment-holders.equipmentHolder.equipmentHolder_REF

Field NameTypeRead OnlyGETPUT / POSTDescription
@hrefString(URI)NY Y * Link to an external equipmentHolder_REF. Here, href points to the equipmentHolder_REF in the primary equipmentHolder_REF collection.

Hyperlink Template: /api/space/managed-domain/equipment-holders/{*ID}.
idIntegerYY N Object Id.
nameStringYY N EquipmentHolder Name.

exec-backup (vnd.net.juniper.space.config-file-management.exec-backup;version=1)

The 'exec-backup' resource model represents data being passed to the exec-backup API. Exec-backup takes a configuration from a device or a list of devices, and backs it up to the latest version of the configuration file.

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)NY Y Link to this exec-backup node in the current node context. This link can be used to retrieve or operate on the currently referenced exec-backup in the tree path.
devicesexec-backup.configFileMOsNY Y List of devices to back up.
scpPropertyexec-backup.scpPropertyNY Y SCP Property to backup Device Configuration Files.

exec-backup.configFileMOs

Field NameTypeRead OnlyGETPUT / POSTDescription
@sizeIntegerNY Y Total number of devices or configuration files to be backed up (or were backed up).
@uriString(URI)NY Y Link to this configFileMOs node in the current node context. This link can be used to retrieve or operate on the currently referenced configFileMOs in the tree path.
deviceexec-backup.configFileMOs.configFileMO[]NY Y Collection of devices or configuration files to back up.

exec-backup.configFileMOs.configFileMO

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)NY Y NNLink to this configFileMO node in the current node context. This link can be used to retrieve or operate on the currently referenced configFileMO in the tree path.
@hrefString(URI)NY Y NNLink to an external configFileMO. Here, href points to the configFileMO in the primary configFileMO collection.
deviceIdintNY Y NNDevice ID.

exec-backup.scpProperty

This inner class contains SCP properties which is used for transfer configuration file to Remote server

Field NameTypeRead OnlyGETPUT / POSTDescription
ipAddressStringNY Y Initialize Remote server address.
portintNY Y * Initialize Remote server Port.
fingerprintStringNY Y Initialize Remote server Fingerprint.
directoryStringNY Y Initialize Remote server path, which is used for where the configuration file going to placed.
user-nameStringNY Y Initialize remote server auth userName.
passwordStringNY Y Initialize remote server password.
credentialTypeStringNY Y credentialType {CREDENTIAL_BASED (or) KEY_BASED (or) CUSTOM_KEY_BASED}.
passPhraseStringNY Y passPhrase.
privateKeyStringNY Y privateKey.

exec-commands (vnd.net.juniper.space.configuration-management.exec-commands;version=5)

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this exec-commands node in the current node context. This link can be used to retrieve or operate on the currently referenced exec-commands in the tree path.
@totalIntegerYY N Total number of exec-commands-results in the API result set. If paging parameters are used in the query to limit the result set size, then total represents the total number of exec-commands-results in all the pages of the result set.
exec-command-resultexec-commands.execCommandResult[]NY Y *  

exec-commands.execCommandResult

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)YY N NNLink to this execCommandResult node in the current node context. This link can be used to retrieve or operate on the currently referenced execCommandResult in the tree path.
error-messageStringNY Y NNError Message.
statusenum(status)NY Y * NNStatus.

Possible Values:
SUCCESS 
FAILURE 
.
repliesexec-commands.execCommandResult.repliesNY Y NN 

exec-commands.execCommandResult.replies

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this replies node in the current node context. This link can be used to retrieve or operate on the currently referenced replies in the tree path.
@totalIntegerYY N Total number of gen_exec-commands-results-exec-commands-replies in the API result set. If paging parameters are used in the query to limit the result set size, then total represents the total number of gen_exec-commands-results-exec-commands-replies in all the pages of the result set.
replyexec-commands.execCommandResult.replies.execCommandReply[]NY Y *  

exec-commands.execCommandResult.replies.execCommandReply

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)YY N NNLink to this execCommandReply node in the current node context. This link can be used to retrieve or operate on the currently referenced execCommandReply in the tree path.
contentStringNY Y * NNContent.

exec-commands-request (vnd.net.juniper.space.configuration-management.exec-commands-request;version=5)

Field NameTypeRead OnlyGETPUT / POSTDescription
device-idIntegerNY Y * Device ID.
commandsexec-commands-request.commandsNY Y *  

exec-commands-request.commands

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this commands node in the current node context. This link can be used to retrieve or operate on the currently referenced commands in the tree path.
commandString[]NY Y * Commands.

exec-deploy (vnd.net.juniper.space.software-management.exec-deploy;version=1)

The 'exec-deploy' resource model represents a view of the information about the deployment of a software package. It consists of the following fields:

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)NY Y Link to this exec-deploy node in the current node context. This link can be used to retrieve or operate on the currently referenced exec-deploy in the tree path.
devicesexec-deploy.devicesNY Y * Devices on which the software package is to be deployed.
deployOptionsexec-deploy.installOptionsNY Y Type 'installOptions' specifies the different deployment options for the software package.

exec-deploy.devices

The 'devices' field of type 'devices' represents a collection of devices on which the software package is to be deployed.

Field NameTypeRead OnlyGETPUT / POSTDescription
deviceexec-deploy.devices.device[]NY Y * A collection of devices on which the software package is to be deployed.

exec-deploy.devices.device

The 'device' field of type 'device' represents a device for software package deployment.

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@keyIntegerNY Y NN A unique identifier for the device
@hrefString(URI)NY Y NNLink to an external device. Here, href points to the device in the primary device collection.
@uriString(URI)NY Y NNLink to this device node in the current node context. This link can be used to retrieve or operate on the currently referenced device in the tree path.

exec-deploy.installOptions

The field 'deployOptions' of type 'installOptions' represents installation options for a software package.

Field NameTypeRead OnlyGETPUT / POSTDescription
useAlreadyDownloadedBooleanNY Y A condition specifying whether or not to use an already downloaded package.
snapShotRequiredBooleanNY Y A condition specifying whether or not a snapshot is required.
validateBooleanNY Y A condition specifying whether or not to validate the software package.
bestEffortLoadBooleanNY Y A condition specifying whether the best effort load is required
removePkgAfterInstallationBooleanNY Y A condition specifying whether or not to remove package after installation.
rebootDeviceBooleanNY Y A condition specifying whether or not to reboot the device after the software package is deployed.
rebootAfterXMinutesIntegerNY Y The time in minutes after which the device should reboot
upgradePrimaryPartitionBooleanNY Y The condition whether backup primary partition
cleanUpExistingOnDeviceBooleanNY Y The condition specifying whether the existing software package on the device should be cleaned up

exec-deploy (vnd.net.juniper.space.script-management.exec-deploy;version=2)

The 'exec-deploy' resource model represents a view of the information about the deployment of the script. It consists of the following fields:

Field NameTypeRead OnlyGETPUT / POSTDescription
scriptMgmtexec-deploy.scriptMgmt[]NY Y * The set of inputs for the operation
scriptEnablebooleanNY Y A flag that indicates whether a script or scripts are enabled while staging the script on a device. When this flag is set to false, Junos Space only stages and does not enable the script on that particular device. The default is to stage and enable the script.

exec-deploy.scriptMgmt

The 'scriptMgmt' field of type 'scriptMgmt' contains the following fields required for the operation:

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
scriptexec-deploy.scriptNY Y * NN A unique identifier for the script
scriptVersionSelectedFloatNY Y NN The version of the scrip
deviceexec-deploy.deviceNY Y * NN The device type on which the operation is to be performed
scriptParamexec-deploy.scriptParams[]NY Y NN The list of parameters needed by the script

exec-deploy.scriptParams

The 'scriptParams' field of type 'scriptParams' represents different parameters needed for the operation. It consists of the following fields:

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
paramNameStringNY Y * NN The parameter name
paramValueStringNY Y * NN The parameter value

exec-deploy.device

The 'device' field of the 'device' type represents details about the device. It consists of the following fields:

Field NameTypeRead OnlyGETPUT / POSTDescription
@hrefString(URI)NY Y Link to an external device. Here, href points to the device in the primary device collection.
@uriString(URI)NY Y Link to this device node in the current node context. This link can be used to retrieve or operate on the currently referenced device in the tree path.

exec-deploy.script

The 'script' resource model is a complex type and can be further defined by the following fields:

Field NameTypeRead OnlyGETPUT / POSTDescription
@hrefString(URI)NY Y Link to an external script. Here, href points to the script in the primary script collection.
@uriString(URI)NY Y Link to this script node in the current node context. This link can be used to retrieve or operate on the currently referenced script in the tree path.

exec-deploy-jam-request (vnd.net.juniper.space.software-management.exec-deploy-jam-request;version=1)

The 'exec-deploy-jam-request' resource model represents a view of the information about the deployment of a JAM Package. It consists of the following fields:

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this exec-deploy-jam-request node in the current node context. This link can be used to retrieve or operate on the currently referenced exec-deploy-jam-request in the tree path.
devicesexec-deploy-jam-request.devicesNY Y * Devices on which the JAM Package is to be deployed.
deployOptionsexec-deploy-jam-request.deviceImageInstallOptionsNY Y Type 'deployOptions' specifies the different Deployment Option(s) ( i.e. whether or not to use an already downloaded JAM Package in the Device ) for the JAM Package.

exec-deploy-jam-request.devices

Devices on which the JAM Package is to be deployed.

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this devices node in the current node context. This link can be used to retrieve or operate on the currently referenced devices in the tree path.

Hyperlink Template: /devices.
deviceexec-deploy-jam-request.devices.device[]NY Y * A collection of Devices on which the JAM Package is to be deployed.

exec-deploy-jam-request.devices.device

A collection of Devices on which the JAM Package is to be deployed.

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@hrefString(URI)NY Y * NNLink to an external device. Here, href points to the device in the primary device collection.

Hyperlink Template: /api/space/device-management/devices/{*ID}.
idIntegerYY N YYID of the Device on which the JAM package is to be deployed.
nameStringYY N YYName of the on which the JAM package is to be deployed.

exec-deploy-jam-request.deviceImageInstallOptions

Type 'deployOptions' specifies the different Deployment Option(s) ( i.e. whether or not to use an already downloaded JAM Package in the Device ) for the JAM Package.

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this deviceImageInstallOptions node in the current node context. This link can be used to retrieve or operate on the currently referenced deviceImageInstallOptions in the tree path.
use-already-downloaded-jamBooleanNY Y A condition specifying whether or not to use an already downloaded JAM Package in the Device.

Default: false.

exec-deploy-multiple-support (vnd.net.juniper.space.script-management.exec-deploy-multiple-support;version=2)

The deploy request body.

Field NameTypeRead OnlyGETPUT / POSTDescription
script-deploy-profilesexec-deploy-multiple-support.scriptDeployListsNY Y * Contains multiple execution set. Each execution set has its information about scripts and devices.

exec-deploy-multiple-support.scriptDeployLists

Contains multiple execution set. Each execution set has its information about scripts and devices.

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this scriptDeployLists node in the current node context. This link can be used to retrieve or operate on the currently referenced scriptDeployLists in the tree path.
script-deploy-profileexec-deploy-multiple-support.scriptDeployLists.scriptDeploy[]NY Y * Describes an execution set of scripts and devices.

exec-deploy-multiple-support.scriptDeployLists.scriptDeploy

Describes an execution set of scripts and devices.

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)YY N NNLink to this scriptDeploy node in the current node context. This link can be used to retrieve or operate on the currently referenced scriptDeploy in the tree path.
script-detailsexec-deploy-multiple-support.scriptDeployLists.scriptDeploy.scriptdetailsNY Y * NNCollection of details of multiple scripts.
devicesexec-deploy-multiple-support.scriptDeployLists.scriptDeploy.deviceIDsNY Y * NNDevice details list.

exec-deploy-multiple-support.scriptDeployLists.scriptDeploy.scriptdetails

Collection of details of multiple scripts.

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this scriptdetails node in the current node context. This link can be used to retrieve or operate on the currently referenced scriptdetails in the tree path.

Hyperlink Template: /scriptdetails.
@totalIntegerYY N Total number of gen_run-deploy-scripts-on-devices_v3-request-script-deploy-lists-script-deploy-lists-scriptdetails in the API result set. If paging parameters are used in the query to limit the result set size, then total represents the total number of gen_run-deploy-scripts-on-devices_v3-request-script-deploy-lists-script-deploy-lists-scriptdetails in all the pages of the result set.
script-detailexec-deploy-multiple-support.scriptDeployLists.scriptDeploy.scriptdetails.deployScript[]NY Y * Details about a single script.

exec-deploy-multiple-support.scriptDeployLists.scriptDeploy.scriptdetails.deployScript

Details about a single script.

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)YY N NNLink to this deployScript node in the current node context. This link can be used to retrieve or operate on the currently referenced deployScript in the tree path.
scriptexec-deploy-multiple-support.scriptDeployLists.scriptDeploy.scriptdetails.deployScript.scriptNY Y * NN 
script-enableBooleanNY Y * NNScript Enable.

Default: true.
script-version-selectedStringNY Y * NNScript Version Selected.
script-paramsexec-deploy-multiple-support.scriptDeployLists.scriptDeploy.scriptdetails.deployScript.scriptParamsNY Y NNParameters for the script.

exec-deploy-multiple-support.scriptDeployLists.scriptDeploy.scriptdetails.deployScript.script

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this script node in the current node context. This link can be used to retrieve or operate on the currently referenced script in the tree path.

Hyperlink Template: /scriptdetails.
@hrefString(URI)NY Y * Link to an external script. Here, href points to the script in the primary script collection.

Hyperlink Template: /api/space/script-management/scripts/{*ID}.
idIntegerYY N Script ID.

exec-deploy-multiple-support.scriptDeployLists.scriptDeploy.scriptdetails.deployScript.scriptParams

Parameters for the script.

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this scriptParams node in the current node context. This link can be used to retrieve or operate on the currently referenced scriptParams in the tree path.

Hyperlink Template: /scriptdetails/script-params.
@totalIntegerYY 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. If paging parameters are used in the query to limit the result set size, then total represents the 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 all the pages of the result set.
script-params-guiexec-deploy-multiple-support.scriptDeployLists.scriptDeploy.scriptdetails.deployScript.scriptParams.scriptParamsGUI[]NY Y  

exec-deploy-multiple-support.scriptDeployLists.scriptDeploy.scriptdetails.deployScript.scriptParams.scriptParamsGUI

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)YY N NNLink to this scriptParamsGUI node in the current node context. This link can be used to retrieve or operate on the currently referenced scriptParamsGUI in the tree path.
param-valueStringNY Y * NNParam Value.
param-nameStringNY Y * NNParam Name.

exec-deploy-multiple-support.scriptDeployLists.scriptDeploy.deviceIDs

Device details list.

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this deviceIDs node in the current node context. This link can be used to retrieve or operate on the currently referenced deviceIDs in the tree path.
@totalIntegerYY 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. If paging parameters are used in the query to limit the result set size, then total represents the total number of gen_run-deploy-scripts-on-devices_v3-request-script-deploy-lists-script-deploy-lists-device-ids in all the pages of the result set.
deviceexec-deploy-multiple-support.scriptDeployLists.scriptDeploy.deviceIDs.device[]NY Y *  

exec-deploy-multiple-support.scriptDeployLists.scriptDeploy.deviceIDs.device

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)YY N NNLink to this device node in the current node context. This link can be used to retrieve or operate on the currently referenced device in the tree path.
@hrefString(URI)NY Y * NNLink to an external device. Here, href points to the device in the primary device collection.

Hyperlink Template: /api/space/device-management/devices/{*ID}.
idIntegerYY N YYDevice ID.
nameStringYY N YYDevice Name.

exec-deploy-request (vnd.net.juniper.space.script-management.exec-deploy-request;version=3)

The deploy request body.

Field NameTypeRead OnlyGETPUT / POSTDescription
script-deploy-profilesexec-deploy-request.scriptDeployListsNY Y * Contains multiple execution set. Each execution set has its information about scripts and devices.

exec-deploy-request.scriptDeployLists

Contains multiple execution set. Each execution set has its information about scripts and devices.

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this scriptDeployLists node in the current node context. This link can be used to retrieve or operate on the currently referenced scriptDeployLists in the tree path.
script-deploy-profileexec-deploy-request.scriptDeployLists.scriptDeploy[]NY Y * Describes an execution set of scripts and devices.

exec-deploy-request.scriptDeployLists.scriptDeploy

Describes an execution set of scripts and devices.

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)YY N NNLink to this scriptDeploy node in the current node context. This link can be used to retrieve or operate on the currently referenced scriptDeploy in the tree path.
script-detailsexec-deploy-request.scriptDeployLists.scriptDeploy.scriptdetailsNY Y * NNCollection of details of multiple scripts.
devicesexec-deploy-request.scriptDeployLists.scriptDeploy.deviceIDsNY Y * NNDevice details list.

exec-deploy-request.scriptDeployLists.scriptDeploy.scriptdetails

Collection of details of multiple scripts.

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this scriptdetails node in the current node context. This link can be used to retrieve or operate on the currently referenced scriptdetails in the tree path.

Hyperlink Template: /scriptdetails.
@totalIntegerYY N Total number of gen_run-deploy-scripts-on-devices_v3-request-script-deploy-lists-script-deploy-lists-scriptdetails in the API result set. If paging parameters are used in the query to limit the result set size, then total represents the total number of gen_run-deploy-scripts-on-devices_v3-request-script-deploy-lists-script-deploy-lists-scriptdetails in all the pages of the result set.
script-detailexec-deploy-request.scriptDeployLists.scriptDeploy.scriptdetails.deployScript[]NY Y * Details about a single script.

exec-deploy-request.scriptDeployLists.scriptDeploy.scriptdetails.deployScript

Details about a single script.

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)YY N NNLink to this deployScript node in the current node context. This link can be used to retrieve or operate on the currently referenced deployScript in the tree path.
scriptexec-deploy-request.scriptDeployLists.scriptDeploy.scriptdetails.deployScript.scriptNY Y * NN 
script-enableBooleanNY Y * NNScript Enable.

Default: true.
script-version-selectedStringNY Y * NNScript Version Selected.
script-paramsexec-deploy-request.scriptDeployLists.scriptDeploy.scriptdetails.deployScript.scriptParamsNY Y NNParameters for the script.

exec-deploy-request.scriptDeployLists.scriptDeploy.scriptdetails.deployScript.script

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this script node in the current node context. This link can be used to retrieve or operate on the currently referenced script in the tree path.

Hyperlink Template: /scriptdetails.
@hrefString(URI)NY Y * Link to an external script. Here, href points to the script in the primary script collection.

Hyperlink Template: /api/space/script-management/scripts/{*ID}.
idIntegerYY N Script ID.

exec-deploy-request.scriptDeployLists.scriptDeploy.scriptdetails.deployScript.scriptParams

Parameters for the script.

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this scriptParams node in the current node context. This link can be used to retrieve or operate on the currently referenced scriptParams in the tree path.

Hyperlink Template: /scriptdetails/script-params.
@totalIntegerYY 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. If paging parameters are used in the query to limit the result set size, then total represents the 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 all the pages of the result set.
script-params-guiexec-deploy-request.scriptDeployLists.scriptDeploy.scriptdetails.deployScript.scriptParams.scriptParamsGUI[]NY Y  

exec-deploy-request.scriptDeployLists.scriptDeploy.scriptdetails.deployScript.scriptParams.scriptParamsGUI

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)YY N NNLink to this scriptParamsGUI node in the current node context. This link can be used to retrieve or operate on the currently referenced scriptParamsGUI in the tree path.
param-valueStringNY Y * NNParam Value.
param-nameStringNY Y * NNParam Name.

exec-deploy-request.scriptDeployLists.scriptDeploy.deviceIDs

Device details list.

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this deviceIDs node in the current node context. This link can be used to retrieve or operate on the currently referenced deviceIDs in the tree path.
@totalIntegerYY 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. If paging parameters are used in the query to limit the result set size, then total represents the total number of gen_run-deploy-scripts-on-devices_v3-request-script-deploy-lists-script-deploy-lists-device-ids in all the pages of the result set.
deviceexec-deploy-request.scriptDeployLists.scriptDeploy.deviceIDs.device[]NY Y *  

exec-deploy-request.scriptDeployLists.scriptDeploy.deviceIDs.device

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)YY N NNLink to this device node in the current node context. This link can be used to retrieve or operate on the currently referenced device in the tree path.
@hrefString(URI)NY Y * NNLink to an external device. Here, href points to the device in the primary device collection.

Hyperlink Template: /api/space/device-management/devices/{*ID}.
idIntegerYY N YYDevice ID.
nameStringYY N YYDevice Name.

exec-deploy-request (vnd.net.juniper.space.config-template-management.exec-deploy-request;version=2)

The request object for template deployment contains the list of devices to which the configuration template will be deployed.

Field NameTypeRead OnlyGETPUT / POSTDescription
devicesexec-deploy-request.deviceListsNY Y * The list of devices for deployment of the configuration template.
resolved-variablesexec-deploy-request.resolvedVariablesNY Y * A list of resolved variables based on the device.

exec-deploy-request.deviceLists

The list of devices for deployment of the configuration template.

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this deviceLists node in the current node context. This link can be used to retrieve or operate on the currently referenced deviceLists in the tree path.
deviceexec-deploy-request.deviceLists.device[]NY Y * The device to which to deploy the configuration template.

exec-deploy-request.deviceLists.device

The device to which to deploy the configuration template.

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)YY N NNLink to this device node in the current node context. This link can be used to retrieve or operate on the currently referenced device in the tree path.
@hrefString(URI)NY Y * NNLink to an external device. Here, href points to the device in the primary device collection.

Hyperlink Template: /api/space/device-management/devices/{*ID}.
idIntegerYY N YY 
nameStringYY N YYDevice Name.

exec-deploy-request.resolvedVariables

A list of resolved variables based on the device.

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this resolvedVariables node in the current node context. This link can be used to retrieve or operate on the currently referenced resolvedVariables in the tree path.
deviceexec-deploy-request.resolvedVariables.resolvedVariablesPerDevice[]NY Y * The list of resolved variables per device.

exec-deploy-request.resolvedVariables.resolvedVariablesPerDevice

The list of resolved variables per device.

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)YY N NNLink to this resolvedVariablesPerDevice node in the current node context. This link can be used to retrieve or operate on the currently referenced resolvedVariablesPerDevice in the tree path.
device-idIntegerNY Y * NNThe ID of the device with the resolved variables.
variablesexec-deploy-request.resolvedVariables.resolvedVariablesPerDevice.variablesNY Y * NNThe list of resolved variables on the device.

exec-deploy-request.resolvedVariables.resolvedVariablesPerDevice.variables

The list of resolved variables on the device.

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this variables node in the current node context. This link can be used to retrieve or operate on the currently referenced variables in the tree path.

Hyperlink Template: /variables.
@totalIntegerYY N Total number of gen_exec-deploy-request-resolved-variables-resolved-variables-variables in the API result set. If paging parameters are used in the query to limit the result set size, then total represents the total number of gen_exec-deploy-request-resolved-variables-resolved-variables-variables in all the pages of the result set.
variableexec-deploy-request.resolvedVariables.resolvedVariablesPerDevice.variables.resolvedSingleVariable[]NY Y * The resolved variable on the device.

exec-deploy-request.resolvedVariables.resolvedVariablesPerDevice.variables.resolvedSingleVariable

The resolved variable on the device.

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)YY N NNLink to this resolvedSingleVariable node in the current node context. This link can be used to retrieve or operate on the currently referenced resolvedSingleVariable in the tree path.
valuesexec-deploy-request.resolvedVariables.resolvedVariablesPerDevice.variables.resolvedSingleVariable.valuesNY Y * NNThe list of values for the resolved variable.
nameStringNY Y * NNThe name of the variable.

exec-deploy-request.resolvedVariables.resolvedVariablesPerDevice.variables.resolvedSingleVariable.values

The list of values for the resolved variable.

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this values node in the current node context. This link can be used to retrieve or operate on the currently referenced values in the tree path.
@totalIntegerYY N Total number of gen_exec-deploy-request-resolved-variables-resolved-variables-variables-variables-values in the API result set. If paging parameters are used in the query to limit the result set size, then total represents the total number of gen_exec-deploy-request-resolved-variables-resolved-variables-variables-variables-values in all the pages of the result set.
valueString[]NY Y * The value of the variable.

exec-disable (vnd.net.juniper.space.script-management.exec-disable;version=2)

The 'exec-disable' resource model represents a view of the information about disabling a script. It consists of following fields:

Field NameTypeRead OnlyGETPUT / POSTDescription
scriptMgmtexec-disable.scriptMgmt[]NY Y * The set of inputs for the operation

exec-disable.scriptMgmt

This 'scriptMgmt' field of the 'exec-disable' resource model provides a user's view of the 'ScriptMgmt' resource in Junos Space. This field is a complex type 'scriptMgmt', which consists of following pull-through fields:

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
scriptexec-disable.scriptNY Y * NN A unique identifier for the script
scriptVersionSelectedFloatNY Y NN The version of the script
deviceexec-disable.deviceNY Y * NN The device type on which the operation is to be performed
scriptParamexec-disable.scriptParams[]NY Y NN The list of parameters needed by the script.

exec-disable.scriptParams

The 'scriptParams' field of type 'scriptParams' represent different parameters needed for operation. It consists of the following fields:

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
paramNameStringNY Y * NN The parameter name
paramValueStringNY Y * NN The parameter value

exec-disable.device

The 'device' resource model is a complex type and can be further defined by the following fields:

Field NameTypeRead OnlyGETPUT / POSTDescription
@hrefString(URI)NY Y Link to an external device. Here, href points to the device in the primary device collection.
@uriString(URI)NY Y Link to this device node in the current node context. This link can be used to retrieve or operate on the currently referenced device in the tree path.

exec-disable.script

The 'script' resource model is a complex type and can be further defined by the following fields:

Field NameTypeRead OnlyGETPUT / POSTDescription
@hrefString(URI)NY Y Link to an external script. Here, href points to the script in the primary script collection.
@uriString(URI)NY Y Link to this script node in the current node context. This link can be used to retrieve or operate on the currently referenced script in the tree path.

exec-enable (vnd.net.juniper.space.script-management.exec-enable;version=2)

The 'exec-enable' resource model represents a view of the information about enabling the script on the device. It consists of the following fields:

Field NameTypeRead OnlyGETPUT / POSTDescription
scriptMgmtexec-enable.scriptMgmt[]NY Y * The set of inputs for the operation

exec-enable.scriptMgmt

The 'scriptMgmt' field of type 'scriptMgmt' represents the following fields required for the operation:

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
scriptexec-enable.scriptNY Y * NN A unique identifier for the script
scriptVersionSelectedFloatNY Y NN The version of the script
deviceexec-enable.deviceNY Y * NN The device type on which the operation is to be performed.
scriptParamexec-enable.scriptParams[]NY Y NN The list of parameters needed by the script.

exec-enable.scriptParams

This resource model is a user's view of the 'scriptParams' resource in Junos Space. The 'scriptParams' type is a complex type and consists of the following pull-through fields:

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
paramNameStringNY Y * NN The parameter name
paramValueStringNY Y * NN The parameter value

exec-enable.device

The 'device' field is a 'device' type that represents details about a device. It consists of the following fields:

Field NameTypeRead OnlyGETPUT / POSTDescription
@hrefString(URI)NY Y Link to an external device. Here, href points to the device in the primary device collection.
@uriString(URI)NY Y Link to this device node in the current node context. This link can be used to retrieve or operate on the currently referenced device in the tree path.

exec-enable.script

The 'script' type is a complex type and can be further defined by the following fields:

Field NameTypeRead OnlyGETPUT / POSTDescription
@hrefString(URI)NY Y Link to an external script. Here, href points to the script in the primary script collection.
@uriString(URI)NY Y Link to this script node in the current node context. This link can be used to retrieve or operate on the currently referenced script in the tree path.

exec-publish-request (vnd.net.juniper.space.config-template-management.exec-publish-request;version=2)

The request object for template deployment contains the list of devices to which the configuration template will be published.

Field NameTypeRead OnlyGETPUT / POSTDescription
devicesexec-publish-request.devicesNY Y * List of devices to which the template is published.
resolved-variablesexec-publish-request.resolvedVariablesNY Y * The list of resolved variables based on the device.

exec-publish-request.devices

List of devices to which the template is published.

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this devices node in the current node context. This link can be used to retrieve or operate on the currently referenced devices in the tree path.
deviceexec-publish-request.devices.device[]NY Y * The device to which the template is published.

exec-publish-request.devices.device

The device to which the template is published.

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)YY N NNLink to this device node in the current node context. This link can be used to retrieve or operate on the currently referenced device in the tree path.
@hrefString(URI)NY Y * NNLink to an external device. Here, href points to the device in the primary device collection.

Hyperlink Template: /api/space/device-management/devices/{*ID}.
idIntegerYY N YY 
nameStringYY N YYDevice Name.

exec-publish-request.resolvedVariables

The list of resolved variables based on the device.

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this resolvedVariables node in the current node context. This link can be used to retrieve or operate on the currently referenced resolvedVariables in the tree path.
deviceexec-publish-request.resolvedVariables.resolvedVariablesPerDevice[]NY Y * The list of resolved variables per device.

exec-publish-request.resolvedVariables.resolvedVariablesPerDevice

The list of resolved variables per device.

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)YY N NNLink to this resolvedVariablesPerDevice node in the current node context. This link can be used to retrieve or operate on the currently referenced resolvedVariablesPerDevice in the tree path.
device-idIntegerNY Y * NNThe ID of the device with the resolved variables.
variablesexec-publish-request.resolvedVariables.resolvedVariablesPerDevice.variablesNY Y * NNThe list of resolved variables on the device.

exec-publish-request.resolvedVariables.resolvedVariablesPerDevice.variables

The list of resolved variables on the device.

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this variables node in the current node context. This link can be used to retrieve or operate on the currently referenced variables in the tree path.

Hyperlink Template: /variables.
@totalIntegerYY N Total number of gen_exec-publish-request-resolved-variables-resolved-variables-variables in the API result set. If paging parameters are used in the query to limit the result set size, then total represents the total number of gen_exec-publish-request-resolved-variables-resolved-variables-variables in all the pages of the result set.
variableexec-publish-request.resolvedVariables.resolvedVariablesPerDevice.variables.resolvedSingleVariable[]NY Y * The resolved varialbe on the device.

exec-publish-request.resolvedVariables.resolvedVariablesPerDevice.variables.resolvedSingleVariable

The resolved varialbe on the device.

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)YY N NNLink to this resolvedSingleVariable node in the current node context. This link can be used to retrieve or operate on the currently referenced resolvedSingleVariable in the tree path.
valuesexec-publish-request.resolvedVariables.resolvedVariablesPerDevice.variables.resolvedSingleVariable.valuesNY Y NNThe values of the variable.
nameStringNY Y * NNThe name of the variable.

exec-publish-request.resolvedVariables.resolvedVariablesPerDevice.variables.resolvedSingleVariable.values

The values of the variable.

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this values node in the current node context. This link can be used to retrieve or operate on the currently referenced values in the tree path.
@totalIntegerYY N Total number of gen_exec-publish-request-resolved-variables-resolved-variables-variables-variables-values in the API result set. If paging parameters are used in the query to limit the result set size, then total represents the total number of gen_exec-publish-request-resolved-variables-resolved-variables-variables-variables-values in all the pages of the result set.
valueString[]NY Y * The value of the variable.

exec-remove (vnd.net.juniper.space.software-management.exec-remove;version=1)

The 'exec-remove' resource model represents a view of the information about the image removal from device. It consists of following fields:

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)NY Y Link to this exec-remove node in the current node context. This link can be used to retrieve or operate on the currently referenced exec-remove in the tree path.
devicesexec-remove.devicesNY Y * Devices on which the software package is to be removed.

exec-remove.devices

The field 'devices' of type 'devices' represents the collection of devices on which the software package is to be removed.

Field NameTypeRead OnlyGETPUT / POSTDescription
deviceexec-remove.devices.device[]NY Y * The collection of devices on which the software package is to be removed.

exec-remove.devices.device

The 'device' field of 'device' type represents a device for removing the software package.

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@keyIntegerNY Y NN A unique identifier for the device
@hrefString(URI)NY Y NNLink to an external device. Here, href points to the device in the primary device collection.
@uriString(URI)NY Y NNLink to this device node in the current node context. This link can be used to retrieve or operate on the currently referenced device in the tree path.

exec-remove (vnd.net.juniper.space.script-management.exec-remove;version=2)

The 'exec-remove' resource model represents a view of the information about removal of the script. It consists of the following fields:

Field NameTypeRead OnlyGETPUT / POSTDescription
scriptMgmtexec-remove.scriptMgmt[]NY Y * The set of inputs for the operation
forceRemovebooleanNY Y A flag that indicates whether to forcibly remove the association between a device and script while removing the script from device.

exec-remove.scriptMgmt

The 'scriptMgmt' field of type 'scriptMgmt' represents following fields required for the operation:

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
scriptexec-remove.scriptNY Y * NN A unique identifier for the script.
scriptVersionSelectedFloatNY Y NN The version of the script.
deviceexec-remove.deviceNY Y * NN The device type on which the operation is to be performed
scriptParamexec-remove.scriptParams[]NY Y NN The list of parameters needed by the script

exec-remove.scriptParams

The 'scriptParams' field of type 'scriptParams' represent different parameters needed for operation. It consists of the following fields:

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
paramNameStringNY Y * NN The parameter name
paramValueStringNY Y * NN The parameter value

exec-remove.device

The 'device' field in the 'device' type represents details about the device . It consists of the following fields:

Field NameTypeRead OnlyGETPUT / POSTDescription
@hrefString(URI)NY Y Link to an external device. Here, href points to the device in the primary device collection.
@uriString(URI)NY Y Link to this device node in the current node context. This link can be used to retrieve or operate on the currently referenced device in the tree path.

exec-remove.script

The 'script' resource model is a complex type and can be further defined by the following fields:

Field NameTypeRead OnlyGETPUT / POSTDescription
@hrefString(URI)NY Y Link to an external script. Here, href points to the script in the primary script collection.
@uriString(URI)NY Y Link to this script node in the current node context. This link can be used to retrieve or operate on the currently referenced script in the tree path.

exec-restore (vnd.net.juniper.space.config-file-management.exec-restore;version=1)

The 'exec-restore' resource model represents data being passed to the exec-restore API. Exec-restore takes a configuration from the latest version of the configuration file and deploys it on a device or a list of devices.

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)NY Y Link to this exec-restore node in the current node context. This link can be used to retrieve or operate on the currently referenced exec-restore in the tree path.
exec-restore-specsexec-restore.configFileMOsNY Y A list of specs, each of which contain a device link for the device to be restored.

exec-restore.configFileMOs

Field NameTypeRead OnlyGETPUT / POSTDescription
@sizeIntegerNY Y Total number of devices or configuration files to be restored (or were restored).
@uriString(URI)NY Y Link to this configFileMOs node in the current node context. This link can be used to retrieve or operate on the currently referenced configFileMOs in the tree path.
exec-restore-specexec-restore.configFileMOs.configFileMO[]NY Y A single restore-spec.

exec-restore.configFileMOs.configFileMO

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)NY Y NNLink to this configFileMO node in the current node context. This link can be used to retrieve or operate on the currently referenced configFileMO in the tree path.
@hrefString(URI)NY Y NNLink to an external configFileMO. Here, href points to the configFileMO in the primary configFileMO collection.
restoreTypeStringNY Y NNRestore merge option.
latestVersionIntegerNY Y NNLatest version number.
idintNY Y NNLatest version ID.
config-file-versionStringNY Y NNWhich version of the config file to restore.

exec-rpc-job-results (vnd.net.juniper.space.device-management.exec-rpc-job-results;version=3)

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this exec-rpc-job-results node in the current node context. This link can be used to retrieve or operate on the currently referenced exec-rpc-job-results in the tree path.
@totalIntegerYY N Total number of exec-rpc-job-results in the API result set. If paging parameters are used in the query to limit the result set size, then total represents the total number of exec-rpc-job-results in all the pages of the result set.
exec-rpc-job-resultexec-rpc-job-results.execRPCJobResult[]NY Y *  

exec-rpc-job-results.execRPCJobResult

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)YY N NNLink to this execRPCJobResult node in the current node context. This link can be used to retrieve or operate on the currently referenced execRPCJobResult in the tree path.
idIntegerYY N YYID of the RPC in the execute RPC job result.
resultStringNY Y * YYResult of the RPC executed on the device.
rpcStringNY Y * YYRPC executed on the device.
statusStringNY Y * YYStatus of the RPC executed on the device.
device-idIntegerNY Y * YYID Device of the on which the RPC is executed.

exec-scripts (vnd.net.juniper.space.script-management.exec-scripts;version=2)

The 'exec-scripts' resource model represents a view of the information about execution of the script. It consists of the following fields:

Field NameTypeRead OnlyGETPUT / POSTDescription
scriptMgmtexec-scripts.scriptMgmt[]NY Y * The set of inputs for the operation

exec-scripts.scriptMgmt

The 'scriptMgmt' field of type 'scriptMgmt' represents the following fields required for the operation:

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
scriptexec-scripts.scriptNY Y * NN A unique identifier for the script
scriptVersionSelectedFloatNY Y NN The version of the script
deviceexec-scripts.deviceNY Y * NN The device type on which the operation is to be performed
scriptParamexec-scripts.scriptParams[]NY Y NN The list of parameters needed by the script.

exec-scripts.scriptParams

The 'scriptParams' field of type 'scriptParams' represent different parameters needed for operation. It consists of the following fields:

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
paramNameStringNY Y * NN The parameter name
paramValueStringNY Y * NN The parameter value

exec-scripts.device

The 'device' field of the 'device' type represents details about the device . It consists of the following fields:

Field NameTypeRead OnlyGETPUT / POSTDescription
@hrefString(URI)NY Y Link to an external device. Here, href points to the device in the primary device collection.
@uriString(URI)NY Y Link to this device node in the current node context. This link can be used to retrieve or operate on the currently referenced device in the tree path.

exec-scripts.script

The 'script' resource model is a complex type and can be further defined by the following fields:

Field NameTypeRead OnlyGETPUT / POSTDescription
@hrefString(URI)NY Y Link to an external script. Here, href points to the script in the primary script collection.
@uriString(URI)NY Y Link to this script node in the current node context. This link can be used to retrieve or operate on the currently referenced script in the tree path.

exec-stage (vnd.net.juniper.space.software-management.exec-stage;version=1)

The 'exec-stage' resource model represents a view of the information about the staging of the software package. It consists of following fields:

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)NY Y Link to this exec-stage node in the current node context. This link can be used to retrieve or operate on the currently referenced exec-stage in the tree path.
devicesexec-stage.devicesNY Y * Devices on which the software package is to be staged.
stageOptionsexec-stage.installOptionsNY Y Type 'installOptions' specifies the different staging options for the software package.

exec-stage.devices

The field 'devices' of type 'devices' represents the collection of devices on which the software package is to be staged.

Field NameTypeRead OnlyGETPUT / POSTDescription
deviceexec-stage.devices.device[]NY Y * The collection of devices on which the software package is to be staged.

exec-stage.devices.device

The 'device' field of 'device' type represents a device for staging the software package.

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@keyIntegerNY Y NN A unique identifier for the device
@hrefString(URI)NY Y NNLink to an external device. Here, href points to the device in the primary device collection.
@uriString(URI)NY Y NNLink to this device node in the current node context. This link can be used to retrieve or operate on the currently referenced device in the tree path.

exec-stage.installOptions

The field 'stageOptions' of type 'installOptions' represents staging options for a software package.

Field NameTypeRead OnlyGETPUT / POSTDescription
cleanUpExistingOnDeviceBooleanNY Y The condition specifying whether the existing software package on the device should be cleaned up.

exec-undeploy (vnd.net.juniper.space.software-management.exec-undeploy;version=1)

The 'exec-undeploy' resource model represents a view of the information about the undeployment of a JAM Package. It consists of the following fields:

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this exec-undeploy node in the current node context. This link can be used to retrieve or operate on the currently referenced exec-undeploy in the tree path.
devicesexec-undeploy.devicesNY Y * Devices from which the JAM Package is to be Undeployed.

exec-undeploy.devices

Devices from which the JAM Package is to be Undeployed.

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this devices node in the current node context. This link can be used to retrieve or operate on the currently referenced devices in the tree path.

Hyperlink Template: /devices.
deviceexec-undeploy.devices.device[]NY Y * A collection of Devices from which the JAM Package is to be Undeployed.

exec-undeploy.devices.device

A collection of Devices from which the JAM Package is to be Undeployed.

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@hrefString(URI)NY Y * NNLink to an external device. Here, href points to the device in the primary device collection.

Hyperlink Template: /api/space/device-management/devices/{*ID}.
idIntegerYY N YYID of the Device from which the JAM package is to be Undeployed.
nameStringYY N YYName of the Device from which the JAM package is to be Undeployed.

exec-undeploy-request (vnd.net.juniper.space.config-template-management.exec-undeploy-request;version=1)

The request object for template undeployment contains the list of devices from which to undeploy the configuration template.

Field NameTypeRead OnlyGETPUT / POSTDescription
devicesexec-undeploy-request.deviceListsNY Y * The the list of devices for template undeployment.

exec-undeploy-request.deviceLists

The the list of devices for template undeployment.

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)NY Y Link to this deviceLists node in the current node context. This link can be used to retrieve or operate on the currently referenced deviceLists in the tree path.
deviceexec-undeploy-request.deviceLists.device[]NY Y * The device from which to undeploy the configuration template.

exec-undeploy-request.deviceLists.device

The device from which to undeploy the configuration template.

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@hrefString(URI)NY Y * NNLink to an external device. Here, href points to the device in the primary device collection.

Hyperlink Template: /api/space/device-management/devices/{*ID}.
@uriString(URI)YY N NNLink to this device node in the current node context. This link can be used to retrieve or operate on the currently referenced device in the tree path.
idIntegerYY N NNThe ID of the device from which to undeploy the template.

execute-export-device-configuration-request (vnd.net.juniper.space.configuration-management.execute-export-device-configuration-request;version=3)

Configuration for exporting device configuration

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this execute-export-device-configuration-request node in the current node context. This link can be used to retrieve or operate on the currently referenced execute-export-device-configuration-request in the tree path.
x-dateStringNY Y * X Date.
device-listexecute-export-device-configuration-request.deviceListsNY Y *  
content-typeenum(content-type)NY Y * Content Type.

Possible Values:
XML 
CLI 
BOTH 
.

execute-export-device-configuration-request.deviceLists

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this deviceLists node in the current node context. This link can be used to retrieve or operate on the currently referenced deviceLists in the tree path.

Hyperlink Template: /device-list.
deviceexecute-export-device-configuration-request.deviceLists.device[]NY Y * Device.

execute-export-device-configuration-request.deviceLists.device

Device

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)YY N NNLink to this device node in the current node context. This link can be used to retrieve or operate on the currently referenced device in the tree path.

Hyperlink Template: /device-list/{*ID}.
@hrefString(URI)NY Y * NNLink to an external device. Here, href points to the device in the primary device collection.

Hyperlink Template: /api/space/managed-domain/devices-require-polling/{*ID}.
idIntegerYY N YYDevice ID.
nameStringYY N YYDevice Name.

execute-export-physical-inventory-request (vnd.net.juniper.space.managed-domain.execute-export-physical-inventory-request;version=1)

Field NameTypeRead OnlyGETPUT / POSTDescription
devicesexecute-export-physical-inventory-request.devicesNY Y *  

execute-export-physical-inventory-request.devices

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this devices node in the current node context. This link can be used to retrieve or operate on the currently referenced devices in the tree path.
deviceexecute-export-physical-inventory-request.devices.device[]NY Y *  

execute-export-physical-inventory-request.devices.device

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@hrefString(URI)NY Y * NNLink to an external device. Here, href points to the device in the primary device collection.

Hyperlink Template: /api/space/device-management/devices/{*ID}.
idIntegerYY N YYDevice ID.
nameStringYY N YYDevice Name.

exec-verify (vnd.net.juniper.space.software-management.exec-verify;version=1)

The 'exec-verify' resource model represents a view of the information about the verification of a software package. It consists of the following fields:

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)NY Y Link to this exec-verify node in the current node context. This link can be used to retrieve or operate on the currently referenced exec-verify in the tree path.
devicesexec-verify.devicesNY Y * The devices on which the software package is to be verified.

exec-verify.devices

The 'devices' field of type 'devices' represents the collection of devices on which the software package is to be verified.

Field NameTypeRead OnlyGETPUT / POSTDescription
deviceexec-verify.devices.device[]NY Y * The collection of devices on which the software package is to be verified.

exec-verify.devices.device

The 'device' field of 'device' type represents a device for software package verification.

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@keyIntegerNY Y NN The unique identifier for the device
@hrefString(URI)NY Y NNLink to an external device. Here, href points to the device in the primary device collection.
@uriString(URI)NY Y NNLink to this device node in the current node context. This link can be used to retrieve or operate on the currently referenced device in the tree path.

exec-verify (vnd.net.juniper.space.script-management.exec-verify;version=2)

The 'exec-verify' resource model represents a view of the information about the verification of the script. It consists of the following fields:

Field NameTypeRead OnlyGETPUT / POSTDescription
scriptMgmtexec-verify.scriptMgmt[]NY Y * The set of inputs for the operation.

exec-verify.scriptMgmt

The 'scriptMgmt' field of type 'scriptMgmt' represents the following fields required for the operation:

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
scriptexec-verify.scriptNY Y * NN A unique identifier for the script
scriptVersionSelectedFloatNY Y NN The version of the script
deviceexec-verify.deviceNY Y * NN The device type on which the operation is to be performed
scriptParamexec-verify.scriptParams[]NY Y NN The list of parameters needed by the script.

exec-verify.scriptParams

The 'scriptParams' field of type 'scriptParams' represent different parameters needed for the operation.It consists of the following fields:

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
paramNameStringNY Y * NN The parameter name
paramValueStringNY Y * NN The parameter value

exec-verify.device

The 'device' field of the 'device' type represents details about the device. It consists of the following fields:

Field NameTypeRead OnlyGETPUT / POSTDescription
@hrefString(URI)NY Y Link to an external device. Here, href points to the device in the primary device collection.
@uriString(URI)NY Y Link to this device node in the current node context. This link can be used to retrieve or operate on the currently referenced device in the tree path.

exec-verify.script

The 'script' resource model is a complex type and can be further defined by the following fields:

Field NameTypeRead OnlyGETPUT / POSTDescription
@hrefString(URI)NY Y Link to an external script. Here, href points to the script in the primary script collection.
@uriString(URI)NY Y Link to this script node in the current node context. This link can be used to retrieve or operate on the currently referenced script in the tree path.

expanded-cli-configuration (vnd.net.juniper.space.device-management.expanded-cli-configuration;version=5)

configuration details

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this expanded-cli-configuration node in the current node context. This link can be used to retrieve or operate on the currently referenced expanded-cli-configuration in the tree path.
*idIntegerYY N DeviceConfiguration ID.
configurationStringNY Y * Configuration.

expanded-cli-configuration-request (vnd.net.juniper.space.device-management.expanded-cli-configuration-request;version=5)

Xpath list request

Field NameTypeRead OnlyGETPUT / POSTDescription
xpath-listexpanded-cli-configuration-request.xpathListsNY Y Xpath list.

expanded-cli-configuration-request.xpathLists

Xpath list

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this xpathLists node in the current node context. This link can be used to retrieve or operate on the currently referenced xpathLists in the tree path.
xpathString[]NY Y * Xpath for which the configuration will be fetched.

expanded-configuration (vnd.net.juniper.space.device-management.expanded-configuration;version=1)

The 'expanded-configuration' resource model represents access configuration data with configuration groups expanded (using the inherit="inherit" option on the Junos OS "get-configuration" RPC) of a device. It can be defined further by the following fields:

Field NameTypeRead OnlyGETPUT / POSTDescription
configurationStringNY Y * The configuration string.
idIntegerNY Y Unique identifier for the expanded configuration
methodStringNY Y Represents a link to a POST method that is used to match the content of the configuration.

expanded-configuration (vnd.net.juniper.space.device-management.expanded-configuration;version=3)

The 'expanded-configuration' resource model represents access configuration data with configuration groups expanded (using the inherit="inherit" option on the Junos OS "get-configuration" RPC) of a device. It can further be defined by the following fields:

Field NameTypeRead OnlyGETPUT / POSTDescription
configurationStringNY Y * The configuration string.
idIntegerNY Y Unique identifier for expanded configuration
methodStringNY Y This represent a link to a POST method that is used to match the content of the configuration.

expanded-xml-configuration (vnd.net.juniper.space.device-management.expanded-xml-configuration;version=5)

configuration details

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this expanded-xml-configuration node in the current node context. This link can be used to retrieve or operate on the currently referenced expanded-xml-configuration in the tree path.
*idIntegerYY N DeviceConfiguration ID.
configurationStringYY N Configuration.

expanded-xml-configuration-request (vnd.net.juniper.space.device-management.expanded-xml-configuration-request;version=5)

Xpath list configuration request

Field NameTypeRead OnlyGETPUT / POSTDescription
xpath-listexpanded-xml-configuration-request.xpathListsNY Y Xpath list.

expanded-xml-configuration-request.xpathLists

Xpath list

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this xpathLists node in the current node context. This link can be used to retrieve or operate on the currently referenced xpathLists in the tree path.
xpathString[]NY Y * Xpath for which the configuration will be fetched.

export-ctp-interface-request (vnd.net.juniper.space.managed-domain.export-ctp-interface-request;version=1)

Field NameTypeRead OnlyGETPUT / POSTDescription
device-listexport-ctp-interface-request.deviceListsNY Y *  

export-ctp-interface-request.deviceLists

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this deviceLists node in the current node context. This link can be used to retrieve or operate on the currently referenced deviceLists in the tree path.
deviceexport-ctp-interface-request.deviceLists.device[]NY Y *  

export-ctp-interface-request.deviceLists.device

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@hrefString(URI)NY Y * NNLink to an external device. Here, href points to the device in the primary device collection.

Hyperlink Template: /api/space/device-management/devices/{*ID}.
idIntegerYY N YYDevice ID.
nameStringYY N YYDevice Name.

export-ptp-interface-request (vnd.net.juniper.space.managed-domain.export-ptp-interface-request;version=1)

Field NameTypeRead OnlyGETPUT / POSTDescription
device-listexport-ptp-interface-request.deviceListsNY Y *  

export-ptp-interface-request.deviceLists

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this deviceLists node in the current node context. This link can be used to retrieve or operate on the currently referenced deviceLists in the tree path.
deviceexport-ptp-interface-request.deviceLists.device[]NY Y *  

export-ptp-interface-request.deviceLists.device

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@hrefString(URI)NY Y * NNLink to an external device. Here, href points to the device in the primary device collection.

Hyperlink Template: /api/space/device-management/devices/{*ID}.
idIntegerYY N YYDevice ID.
nameStringYY N YYDevice Name.

export-roles-request (vnd.net.juniper.space.user-management.export-roles-request;version=3)

Field NameTypeRead OnlyGETPUT / POSTDescription
rolesexport-roles-request.rolesNY Y *  

export-roles-request.roles

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this roles node in the current node context. This link can be used to retrieve or operate on the currently referenced roles in the tree path.
roleexport-roles-request.roles.role[]NY Y *  

export-roles-request.roles.role

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@hrefString(URI)NY Y * NNLink to an external role. Here, href points to the role in the primary roles collection.

Hyperlink Template: /api/space/user-management/roles/{*ID}.
nameStringYY N NNRole Name.
role-idIntegerYY N NNRole ID.

fabric-health-report (vnd.net.juniper.space.fabric-management.fabric-health-report;version=3)

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this fabric-health-report node in the current node context. This link can be used to retrieve or operate on the currently referenced fabric-health-report in the tree path.

Hyperlink Template: /api/space/fabric-management/fabric-health-reports/{*ID}.
@hrefString(URI)YY N Link to an external fabric-health-report. Here, href points to the fabric-health-report in the primary fabric-health-report-refs collection.

Hyperlink Template: /api/space/fabric-management/system-health-report/{*ID}.
*idIntegerYY N FabricHealthReport ID.
processStringNY Y * Process.
parameterStringNY Y * Parameter.
problem-detectedBooleanNY Y * Problem Detected.

Default: false.
last-updated-timeStringNY Y * Last Updated Time.

fabric-health-report-refs (vnd.net.juniper.space.fabric-management.fabric-health-report-refs;version=3)

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this fabric-health-report-refs node in the current node context. This link can be used to retrieve or operate on the currently referenced fabric-health-report-refs in the tree path.
@totalIntegerYY N Total number of fabric-health-reports in the API result set. If paging parameters are used in the query to limit the result set size, then total represents the total number of fabric-health-reports in all the pages of the result set.
fabric-health-reportfabric-health-report-refs.fabricHealthReport[]NY Y *  

fabric-health-report-refs.fabricHealthReport

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)YY N NNLink to this fabricHealthReport node in the current node context. This link can be used to retrieve or operate on the currently referenced fabricHealthReport in the tree path.

Hyperlink Template: /api/space/fabric-management/fabric-health-reports/{*ID}.
@hrefString(URI)NY Y * NNLink to an external fabricHealthReport. Here, href points to the fabricHealthReport in the primary fabric-health-report-refs collection.

Hyperlink Template: /api/space/fabric-management/fabric-health-reports/{*ID}.
idIntegerYY N YYFabricHealthReport ID.
processStringYY N YYProcess.
parameterStringYY N NNParameter.
problem-detectedBooleanYY N YYProblem Detected.

Default: false.

fabric-hprof-file (vnd.net.juniper.space.fabric-management.fabric-hprof-file;version=3)

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this fabric-hprof-file node in the current node context. For primary collection members, href and uri are always the same.

Hyperlink Template: /api/space/fabric-management/hprof-files/{*ID}.
@hrefString(URI)YY N Link to an external fabric-hprof-file. Here, href points to the fabric-hprof-file in the primary fabric-hprof-files collection.

Hyperlink Template: /api/space/fabric-management/hprof-files/{*ID}.
*idIntegerYY N ID.
file-pathStringNY Y * Location of the HPROF file on the node.
node-host-nameStringNY Y * Node Host Name.
node-nameStringNY Y * Logical name assigned to the node.
created-timeStringNY Y * Time when the HPROF file was created on the node.
management-ipStringYY N IPv4 address for the node.
management-ipv6StringYY N IPv6 address for the node.
fabric-nodefabric-hprof-file.fabricNodeNY Y *  

fabric-hprof-file.fabricNode

Field NameTypeRead OnlyGETPUT / POSTDescription
@hrefString(URI)NY Y * Link to an external fabricNode. Here, href points to the fabricNode in the primary fabricNode collection.

Hyperlink Template: /api/space/fabric-management/fabric-nodes/{*ID}.
idIntegerYY N FabricNode ID.
nameStringYY N FabricNode Name.

fabric-hprof-files (vnd.net.juniper.space.fabric-management.fabric-hprof-files;version=3)

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this fabric-hprof-files node in the current node context. This link can be used to retrieve or operate on the currently referenced fabric-hprof-files in the tree path.
@totalIntegerYY N Total number of fabric-hprof-files in the API result set. If paging parameters are used in the query to limit the result set size, then total represents the total number of fabric-hprof-files in all the pages of the result set.
fabric-hprof-filefabric-hprof-files.fabricHprofFile[]NY Y *  

fabric-hprof-files.fabricHprofFile

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)YY N NNLink to this fabricHprofFile node in the current node context. This link can be used to retrieve or operate on the currently referenced fabricHprofFile in the tree path.

Hyperlink Template: /api/space/fabric-management/hprof-files/{*ID}.
@hrefString(URI)YY N NNLink to an external fabric-hprof-file. Here, href points to the fabric-hprof-file in the primary fabric-hprof-files collection.

Hyperlink Template: /api/space/fabric-management/hprof-files/{*ID}.
idIntegerYY N NNID.
file-pathStringNY Y * YYLocation of the HPROF file on the node.
node-host-nameStringNY Y * YYNode Host Name.
node-nameStringNY Y * YYLogical name assigned to the node.
created-timeStringNY Y * YYTime when the HPROF file was created on the node.
management-ipStringYY N YYIPv4 address for the node.
management-ipv6StringYY N YYIPv6 address for the node.

fabric-jboss-reboot-detail (vnd.net.juniper.space.fabric-management.fabric-jboss-reboot-detail;version=3)

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this fabric-jboss-reboot-detail node in the current node context. This link can be used to retrieve or operate on the currently referenced fabric-jboss-reboot-detail in the tree path.

Hyperlink Template: /api/space/fabric-management/fabric-jboss-reboot-details/{*ID}.
@hrefString(URI)YY N Link to an external fabric-jboss-reboot-detail. Here, href points to the fabric-jboss-reboot-detail in the primary fabric-jboss-reboot-details collection.

Hyperlink Template: /api/space/fabric-management/fabric-jboss-reboot-details/{*ID}.
node-idIntegerYY N Node ID.
node-nameStringNY Y Logical name assigned to the node.
last-restart-timeStringNY Y Time when JBoss was last restarted on the node.
management-ipStringYY N IPv4 address for the node.
management-ip-v6StringYY N IPv6 address for the node.
fabric-nodefabric-jboss-reboot-detail.fabricNodeNY Y  

fabric-jboss-reboot-detail.fabricNode

Field NameTypeRead OnlyGETPUT / POSTDescription
@hrefString(URI)NY Y * Link to an external fabricNode. Here, href points to the fabricNode in the primary fabricNode collection.

Hyperlink Template: /api/space/fabric-management/fabric-nodes/{*ID}.
idIntegerYY N FabricNode ID.
nameStringYY N FabricNode Name.

fabric-jboss-reboot-details (vnd.net.juniper.space.fabric-management.fabric-jboss-reboot-details;version=3)

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this fabric-jboss-reboot-details node in the current node context. This link can be used to retrieve or operate on the currently referenced fabric-jboss-reboot-details in the tree path.
@totalIntegerYY N Total number of fabric-jboss-reboot-details in the API result set. If paging parameters are used in the query to limit the result set size, then total represents the total number of fabric-jboss-reboot-details in all the pages of the result set.
fabric-jboss-reboot-detailfabric-jboss-reboot-details.fabricJbossRebootDetail[]NY Y *  

fabric-jboss-reboot-details.fabricJbossRebootDetail

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)YY N NNLink to this fabricJbossRebootDetail node in the current node context. This link can be used to retrieve or operate on the currently referenced fabricJbossRebootDetail in the tree path.

Hyperlink Template: /api/space/fabric-management/fabric-jboss-reboot-details/{*ID}.
@hrefString(URI)YY N NNLink to an external fabricJbossRebootDetail. Here, href points to the fabricJbossRebootDetail in the primary fabric-jboss-reboot-details collection.

Hyperlink Template: /api/space/fabric-management/fabric-jboss-reboot-details/{*ID}.
node-idIntegerYY N YYNode ID.
node-nameStringNY Y YYLogical name assigned to the node.
management-ip-v6StringYY N YYIPv6 address for the node.
last-restart-timeStringNY Y YYTime when JBoss was last restarted on the node.
management-ipStringYY N YYIPv4 address for the node.

fabric-large-table (vnd.net.juniper.space.fabric-management.fabric-large-table;version=3)

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this fabric-large-table node in the current node context. For primary collection members, href and uri are always the same.

Hyperlink Template: /api/space/fabric-management/fabric-large-tables/{*ID}.
@hrefString(URI)YY N Link to an external fabric-large-table. Here, href points to the fabric-large-table in the primary fabric-large-tables collection.

Hyperlink Template: /api/space/fabric-management/fabric-large-tables/{*ID}.
*idIntegerYY N ID.
db-nameStringNY Y * Type of database E.g: MySQL.

Default: "MySQL".
table-nameStringNY Y * Name of the table in the database.
table-sizeFloatNY Y * Size of the table in GB.
timeStringNY Y * Time when the size of the database was last updated.

fabric-large-tables (vnd.net.juniper.space.fabric-management.fabric-large-tables;version=3)

Fabric large Table MO

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this fabric-large-tables node in the current node context. This link can be used to retrieve or operate on the currently referenced fabric-large-tables in the tree path.
@totalIntegerYY N Total number of fabric-large-tables in the API result set. If paging parameters are used in the query to limit the result set size, then total represents the total number of fabric-large-tables in all the pages of the result set.
fabric-large-tablefabric-large-tables.fabricLargeTable[]NY Y *  

fabric-large-tables.fabricLargeTable

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)YY N NNLink to this fabricLargeTable node in the current node context. This link can be used to retrieve or operate on the currently referenced fabricLargeTable in the tree path.

Hyperlink Template: /api/space/fabric-management/fabric-large-tables/{*ID}.
@hrefString(URI)YY N NNLink to an external fabric-large-table. Here, href points to the fabric-large-table in the primary fabric-large-tables collection.

Hyperlink Template: /api/space/fabric-management/fabric-large-tables/{*ID}.
idIntegerYY N YYID.
db-nameStringNY Y * NNType of database E.g: MySQL.

Default: "MySQL".
table-nameStringNY Y * YYName of the table in the database.
table-sizeFloatNY Y * YYSize of the table in GB.
timeStringNY Y * NNTime when the size of the database was last updated.

fabric-node (vnd.api.space.fabric-management.fabric-node;version=2)

Fabric node details

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this fabric-node node in the current node context. This link can be used to retrieve or operate on the currently referenced fabric-node in the tree path.
*idIntegerYY N Fabric Node ID.
nameStringYY 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). For each subsequent node, the user must specify a node name when adding the node to the fabric.
management-ip-v4StringNY Y IPv4 address for the node.
management-ip-v6StringNY Y IPv6 address for the node.
node-typeStringYY N The Description about the type of Node.
space-node-typeStringYY N The description about the type of Space Node.
device-connection-ip-v4StringNY Y IPv4 address for connecting to the device.
device-connection-ip-v6StringNY Y IPv6 address for the node.
statusStringYY N Connection status for the node.

"UP"-Node is connected to the fabric
"DOWN"-Node is disconnected from the fabric.
last-monitored-timeDateYY N Node last monitored time.
last-boot-timeDateYY N Last Boot Time.
cpu-percentageStringYY 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-percentageStringYY 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-percentageStringYY N Percentage of swap memory used.

"Unknown"-Percentage of SWAP memory utilized is unknown, for example, because the node is not connected.
disk-percentageStringYY 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-logicStringYY 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.
databaseStringYY 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-balancerStringYY 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-modelStringYY N Model of the Junos Space Appliance.
software-versionStringYY N Junos Space Network Management Platform release version.
serial-numberStringYY N The serial number for the Junos Space Appliance.
cluster-member-ipsStringYY N IP addresses of the nodes in the fabric.
is-master-nodeBooleanYY N Indicates whether the node is a master node.
is-vip-nodeBooleanYY N Indicates whether the node is a virtual IP (VIP) node. The first (active) node and second (standby) node are VIP nodes.
host-ipStringYY N IP address of the hosted virtual machine. This field is not applicable to Junos Space nodes and Fault Monitoring and Performance Monitoring (FMPM) nodes.
special-node-typeStringYY N The description about the type of Special Node.
fabric-node-statusStringYY N The status of the fabric node. It consists of reboot status and process status

Hyperlink Template: /api/space/fabric-management/fabric-nodes/{*ID}/fabric-node-status.

fabric-node-device-management-session (vnd.net.juniper.space.fabric-management.fabric-node-device-management-session;version=3)

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this fabric-node-device-management-session node in the current node context. For primary collection members, href and uri are always the same.

Hyperlink Template: /api/space/fabric-management/node-device-management-sessions/{*ID}.
@hrefString(URI)YY N Link to an external fabric-node-device-management-session. Here, href points to the fabric-node-device-management-session in the primary fabric-node-device-management-sessions collection.

Hyperlink Template: /api/space/fabric-management/node-device-management-sessions/{*ID}.
*idIntegerYY N ID.
ip-v4StringYY N IPv4 address for the node.
ip-v6StringYY N IPv6 address for the node.
hostStringNY Y * Name of the host machine.
statusStringNY Y * Connection status of the node.
no-of-devicesIntegerNY Y * Number of device.
no-of-devices-console-countIntegerNY Y * Number of device management SSH sessions as calculated by the netstat command.
last-update-timeStringNY Y * Time when the count of device management SSH sessions with devices was last calculated.
fabric-nodefabric-node-device-management-session.fabricNodeNY Y *  

fabric-node-device-management-session.fabricNode

Field NameTypeRead OnlyGETPUT / POSTDescription
@hrefString(URI)NY Y * Link to an external fabricNode. Here, href points to the fabricNode in the primary fabricNode collection.

Hyperlink Template: /api/space/fabric-management/fabric-nodes/{*ID}.
idIntegerYY N FabricNode ID.
nameStringYY N FabricNode Name.

fabric-node-device-management-sessions (vnd.net.juniper.space.fabric-management.fabric-node-device-management-sessions;version=3)

FabricNodeDeviceManagementSession MO

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this fabric-node-device-management-sessions node in the current node context. This link can be used to retrieve or operate on the currently referenced fabric-node-device-management-sessions in the tree path.
@totalIntegerYY N Total number of fabric-node-device-management-sessions in the API result set. If paging parameters are used in the query to limit the result set size, then total represents the total number of fabric-node-device-management-sessions in all the pages of the result set.
fabric-node-device-management-sessionfabric-node-device-management-sessions.fabricNodeDeviceManagementSession[]NY Y *  

fabric-node-device-management-sessions.fabricNodeDeviceManagementSession

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)YY N NNLink to this fabricNodeDeviceManagementSession node in the current node context. This link can be used to retrieve or operate on the currently referenced fabricNodeDeviceManagementSession in the tree path.

Hyperlink Template: /api/space/fabric-management/node-device-management-sessions/{*ID}.
@hrefString(URI)YY N NNLink to an external fabric-node-device-management-session. Here, href points to the fabric-node-device-management-session in the primary fabric-node-device-management-sessions collection.

Hyperlink Template: /api/space/fabric-management/node-device-management-sessions/{*ID}.
idIntegerYY N YYID.
ip-v4StringYY N YYIPv4 address for the node.
ip-v6StringYY N YYIPv6 address for the node.
hostStringNY Y * YYName of the host machine.
statusStringNY Y * YYConnection status of the node.
no-of-devicesIntegerNY Y * YYNumber of device.
no-of-devices-console-countIntegerNY Y * YYNumber of device management SSH sessions as calculated by the netstat command.
last-update-timeStringNY Y * YYTime when the count of device management SSH sessions with devices was last calculated.

fabric-nodes (vnd.api.space.fabric-management.fabric-nodes;version=2)

Collection of all fabric nodes

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this fabric-nodes node in the current node context. This link can be used to retrieve or operate on the currently referenced fabric-nodes in the tree path.
@totalIntegerYY N Total number of fabric-nodes in the API result set. If paging parameters are used in the query to limit the result set size, then total represents the total number of fabric-nodes in all the pages of the result set.
fabric-nodefabric-nodes.fabricNode[]NY Y * Fabric node details.

fabric-nodes.fabricNode

Fabric node details

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)YY N NNLink to this fabricNode node in the current node context. This link can be used to retrieve or operate on the currently referenced fabricNode in the tree path.

Hyperlink Template: /api/space/fabric-management/fabric-nodes/{*ID}.
@hrefString(URI)YY N NNLink to an external fabricNode. Here, href points to the fabricNode in the primary fabricNode collection.

Hyperlink Template: /api/space/fabric-management/fabric-nodes/{*ID}.
idIntegerYY N NNFabric Node ID.
nameStringYY N YNLogical 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). For each subsequent node, the user must specify a node name when adding the node to the fabric.
management-ip-v4StringNY Y YNIPv4 address for the node.
management-ip-v6StringNY Y YNIPv6 address for the node.
node-typeStringYY N NNThe Description about the type of Node.
software-versionStringYY N NNJunos Space Network Management Platform release version.
device-connection-ip-v4StringNY Y NNIPv4 address for connecting to the device.
device-connection-ip-v6StringNY Y NNIPv6 address for connecting to the device.
last-boot-timeDateYY N YYThe last boot time of the node.
last-monitored-timeDateYY N YYNode last monitored time.
space-node-typeStringYY N NNThe description about the type of Space Node.
statusStringYY N YNConnection status for the node.

"UP"-Node is connected to the fabric
"DOWN"-Node is disconnected from the fabric.
app-logicStringYY N YNApplication 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.
databaseStringYY N YNDatabase 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-balancerStringYY N YNLoad 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-ipStringYY N NNIP address of the hosted virtual machine. This field is not applicable to Junos Space nodes and Fault Monitoring and Performance Monitoring (FMPM) nodes.
cpu-percentageStringYY N YNPercentage 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-percentageStringYY N YNPercentage 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-percentageStringYY N YNPercentage of swap memory used.

"Unknown"-Percentage of SWAP memory utilized is unknown, for example, because the node is not connected.
disk-percentageStringYY N NNPercentage 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-typeStringYY N YYThe description about the type of Special Node.

fabric-node-status (vnd.api.space.fabric-management.fabric-node.fabric-node-status;version=2)

Fabric Node process status and reboot status

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this fabric-node-status node in the current node context. This link can be used to retrieve or operate on the currently referenced fabric-node-status in the tree path.

Hyperlink Template: /api/space/fabric-management/fabric-nodes/{*ID}/fabric-node-status.
@hrefString(URI)YY N Link to an external fabric-node-status. Here, href points to the fabric-node-status in the primary fabric-node-status collection.

Hyperlink Template: /api/space/fabric-management/fabric-nodes/{*ID}/fabric-node-status.
fabric-node-idIntegerYY N FabricNodeStatusInfo ID.
reboot-detailfabric-node-status.fabricRebootDetailNY Y * The reboot details of the fabric Node.
processesfabric-node-status.fabricProcessDetailCollectionsNY Y The collection of various processes status running in a fabric Node.

fabric-node-status.fabricRebootDetail

The reboot details of the fabric Node

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this fabricRebootDetail node in the current node context. This link can be used to retrieve or operate on the currently referenced fabricRebootDetail in the tree path.
last-boot-timeLongYY N The time when the last boot operation happened in the fabric node.
last-boot-byStringYY N The name of the user/process who triggered the last boot operation in the fabric node.
last-boot-reasonStringYY N The reason provided for the last boot operation in the fabric node.

fabric-node-status.fabricProcessDetailCollections

The collection of various processes status running in a fabric Node

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this fabricProcessDetailCollections node in the current node context. This link can be used to retrieve or operate on the currently referenced fabricProcessDetailCollections in the tree path.
processfabric-node-status.fabricProcessDetailCollections.fabricProcessDetail[]NY Y * The information about the process running in a fabric Node.

fabric-node-status.fabricProcessDetailCollections.fabricProcessDetail

The information about the process running in a fabric Node

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)YY N NNLink to this fabricProcessDetail node in the current node context. This link can be used to retrieve or operate on the currently referenced fabricProcessDetail in the tree path.
process-nameStringYY N NNThe name of the process running in the node.
statusStringYY N NNThe description of the status of the process running in the node.
cpu-percentageDoubleYY N NNThe percentage of the CPU utilized by the process in the node.
memory-percentageDoubleYY N NNThe percentage of the memory utilized by the process in the node.
start-timeLongYY N NNThe time when the process was started.

feature (vnd.net.juniper.space.application-management.feature;version=3)

Feature's details

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this feature node in the current node context. This link can be used to retrieve or operate on the currently referenced feature in the tree path.

Hyperlink Template: /api/space/application-management/platform/features/{*ID}.
@hrefString(URI)YY N Link to an external feature. Here, href points to the feature in the primary features collection.

Hyperlink Template: /api/space/application-management/platform/features/{*ID}.
*idIntegerYY N Unique key of the feature.
nameStringNY Y * Name of the feature.
enabledBooleanNY Y * States that whether the feature is enabled or not.

Default: true.
descriptionStringNY Y * Feature's description.

features (vnd.net.juniper.space.application-management.features;version=3)

List of available features

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this features node in the current node context. This link can be used to retrieve or operate on the currently referenced features in the tree path.
@totalIntegerYY N Total number of features in the API result set. If paging parameters are used in the query to limit the result set size, then total represents the total number of features in all the pages of the result set.
featurefeatures.paradigmFeature[]NY Y * Feature's details.

features.paradigmFeature

Feature's details

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)YY N NNLink to this paradigmFeature node in the current node context. This link can be used to retrieve or operate on the currently referenced paradigmFeature in the tree path.

Hyperlink Template: /api/space/application-management/platform/features/{*ID}.
@hrefString(URI)YY N NNLink to an external paradigmFeature. Here, href points to the paradigmFeature in the primary features collection.

Hyperlink Template: /api/space/application-management/platform/features/{*ID}.
idIntegerYY N YYUnique key of the feature.
nameStringNY Y * YYName of the feature.
enabledBooleanNY Y * YNStates that whether the feature is enabled or not.

Default: true.
descriptionStringNY Y * YYFeature's description.

filter-equipment-holders-request (vnd.net.juniper.space.managed-domain.filter-equipment-holders-request;version=1)

Field NameTypeRead OnlyGETPUT / POSTDescription
filter-stringStringNY Y * Filter String.
devicesfilter-equipment-holders-request.devicesNY Y  

filter-equipment-holders-request.devices

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this devices node in the current node context. This link can be used to retrieve or operate on the currently referenced devices in the tree path.
devicefilter-equipment-holders-request.devices.device[]NY Y *  

filter-equipment-holders-request.devices.device

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@hrefString(URI)NY Y * NNLink to an external device. Here, href points to the device in the primary device collection.

Hyperlink Template: /api/space/device-management/devices/{*ID}.
idIntegerYY N YYDevice ID.
nameStringYY N YYDevice Name.

filter-equipment-holders-response (vnd.net.juniper.space.managed-domain.filter-equipment-holders-response;version=1)

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this filter-equipment-holders-response node in the current node context. This link can be used to retrieve or operate on the currently referenced filter-equipment-holders-response in the tree path.
@totalIntegerYY N Total number of equipment-holders in the API result set. If paging parameters are used in the query to limit the result set size, then total represents the total number of equipment-holders in all the pages of the result set.
equipment-holderfilter-equipment-holders-response.equipmentHolder[]NY Y *  

filter-equipment-holders-response.equipmentHolder

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)YY N NNLink to this equipmentHolder node in the current node context. This link can be used to retrieve or operate on the currently referenced equipmentHolder in the tree path.

Hyperlink Template: /api/space/managed-domain/equipment-holders/{*ID}.
@hrefString(URI)YY N NNLink to an external equipmentHolder. Here, href points to the equipmentHolder in the primary equipmentHolder collection.

Hyperlink Template: /api/space/managed-domain/equipment-holders/{*ID}.
idIntegerYY N NYObject Id.
nameStringYY N NYEquipmentHolder Name.
device-idIntegerYY N NYDevice ID.
belong-tofilter-equipment-holders-response.equipmentHolder.equipmentHolder_REFYY N NN 

filter-equipment-holders-response.equipmentHolder.equipmentHolder_REF

Field NameTypeRead OnlyGETPUT / POSTDescription
@hrefString(URI)YY N Link to an external equipmentHolder_REF. Here, href points to the equipmentHolder_REF in the primary equipmentHolder_REF collection.

Hyperlink Template: /api/space/managed-domain/equipment-holders/{*ID}.
idIntegerYY N Object Id.
nameStringYY N EquipmentHolder Name.

forwarding-criteria (vnd.net.juniper.space.audit-log-management.audit-log-forwarding.forwarding-criteria;version=2)

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this forwarding-criteria node in the current node context. This link can be used to retrieve or operate on the currently referenced forwarding-criteria in the tree path.
@totalIntegerYY N Total number of forwarding-criteria in the API result set. If paging parameters are used in the query to limit the result set size, then total represents the total number of forwarding-criteria in all the pages of the result set.
forwarding-criterionforwarding-criteria.forwardingCriterion[]NY Y *  

forwarding-criteria.forwardingCriterion

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)YY N NNLink to this forwardingCriterion node in the current node context. This link can be used to retrieve or operate on the currently referenced forwardingCriterion in the tree path.

Hyperlink Template: /api/space/audit-log-management/audit-log-forwarding/forwarding-criteria/{*ID}.
@hrefString(URI)NY Y * NNLink to an external forwarding-criterion-ref. Here, href points to the forwarding-criterion-ref in the primary forwarding-criteria collection.

Hyperlink Template: /api/space/audit-log-management/audit-log-forwarding/forwarding-criteria/{*ID}.
idIntegerYY N YYForwardingCriterion ID.
nameStringYY N YYForwardingCriterion Name.
descriptionStringYY N YYDescription.
syslog-serverforwarding-criteria.forwardingCriterion.syslogServerYY N NN 
enabledBooleanYY N YYEnable the forwarding criterion.

Default: false.
last-updated-userStringYY N YYLast Updated User.
last-updated-timeStringYY N YYLast Updated Time.

forwarding-criteria.forwardingCriterion.syslogServer

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this syslogServer node in the current node context. This link can be used to retrieve or operate on the currently referenced syslogServer in the tree path.
host-addressStringNY Y * Syslog Server Host Address.
portIntegerNY Y * Syslog Server Port.

Default: 514 Min: 0 Max: 65535.
protocolenum(protocol)NY Y * Syslog Server Protocol.

Possible Values:
UDP 
TCP 
TLSv12TLSv1.2
.

forwarding-criterion-ref (vnd.net.juniper.space.audit-log-management.audit-log-forwarding.forwarding-criterion-ref;version=2)

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this forwarding-criterion-ref node in the current node context. For primary collection members, href and uri are always the same.

Hyperlink Template: /api/space/audit-log-management/audit-log-forwarding/forwarding-criteria/{*ID}.
@hrefString(URI)YY N Link to an external forwarding-criterion-ref. Here, href points to the forwarding-criterion-ref in the primary forwarding-criteria collection.

Hyperlink Template: /api/space/audit-log-management/audit-log-forwarding/forwarding-criteria/{*ID}.
*idIntegerYY N ForwardingCriterion ID.
nameStringNY Y ForwardingCriterion Name.
descriptionStringNY Y Description.
syslog-serverforwarding-criterion-ref.syslogServerNY Y *  
enabledBooleanNY Y * Enable the forwarding criterion.

Default: false.
filtersforwarding-criterion-ref.filtersNY Y  

forwarding-criterion-ref.syslogServer

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this syslogServer node in the current node context. This link can be used to retrieve or operate on the currently referenced syslogServer in the tree path.
host-addressStringNY Y * Syslog Server Host Address.
portIntegerNY Y Syslog Server Port.

Default: 514 Min: 0 Max: 65535.
protocolenum(protocol)NY Y * Syslog Server Protocol.

Possible Values:
UDP 
TCP 
TLSv12TLSv1.2
.

forwarding-criterion-ref.filters

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this filters node in the current node context. This link can be used to retrieve or operate on the currently referenced filters in the tree path.
@totalIntegerYY N Total number of gen_forwarding-criterion-filters in the API result set. If paging parameters are used in the query to limit the result set size, then total represents the total number of gen_forwarding-criterion-filters in all the pages of the result set.
filterforwarding-criterion-ref.filters.logFilter[]NY Y *  

forwarding-criterion-ref.filters.logFilter

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)YY N NNLink to this logFilter node in the current node context. This link can be used to retrieve or operate on the currently referenced logFilter in the tree path.
attributeStringNY Y * YYAttribute name.
operatorenum(operator)NY Y * YYCondition.

Possible Values:
EQUALS 
NOT_EQUALS 
LESS_THAN 
GREATER_THAN 
LESS_THAN_EQUALS 
GREATER_THAN_EQUALS 
STARTS_WITH 
ENDS_WITH 
CONTAINS 
.
valueStringNY Y * YYValue.

generate-key-request (vnd.net.juniper.space.fabric-management.generate-key-request;version=4)

Field NameTypeRead OnlyGETPUT / POSTDescription
pass-phraseStringNY Y Pass Phrase.
algorithmStringNY Y *  
key-sizeStringNY Y Key Size.

generate-temp-password-response (vnd.net.juniper.space.user-management.generate-temp-password-response;version=3)

Field NameTypeRead OnlyGETPUT / POSTDescription
valueStringNY Y * Generated temporary password.

get-device-statistics-request (vnd.net.juniper.space.device-management.get-device-statistics-request;version=6)

Get Device statistics request

Field NameTypeRead OnlyGETPUT / POSTDescription
parameterenum(parameter)NY Y * Parameter value on which the Devices should be aggregated.

Possible Values:
OS 
PLATFORMPlatform
STATUSStatus
DOMAINDomain
.

get-device-statistics-response (vnd.net.juniper.space.device-management.get-device-statistics-response;version=6)

Get Device statistics response

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this get-device-statistics-response node in the current node context. This link can be used to retrieve or operate on the currently referenced get-device-statistics-response in the tree path.
parameterStringNY Y * Parameter on which the Device(s) are aggregated.
device-statisticsget-device-statistics-response.deviceStatisticsInfosNY Y * Collection of aggregated Device statistics.

get-device-statistics-response.deviceStatisticsInfos

Collection of aggregated Device statistics

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this deviceStatisticsInfos node in the current node context. This link can be used to retrieve or operate on the currently referenced deviceStatisticsInfos in the tree path.
device-statisticget-device-statistics-response.deviceStatisticsInfos.deviceStatisticsInfo[]NY Y * Aggregated Device statistic on the given parameter.

get-device-statistics-response.deviceStatisticsInfos.deviceStatisticsInfo

Aggregated Device statistic on the given parameter

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)YY N NNLink to this deviceStatisticsInfo node in the current node context. This link can be used to retrieve or operate on the currently referenced deviceStatisticsInfo in the tree path.
nameStringNY Y * NNParameter value on which the Device(s) are aggregated.
valueStringNY Y * NNAggregated value of the Device(s) on the given parameter.

get-syslog-events (vnd.net.juniper.space.device-management.get-syslog-events;version=2)

The 'get-syslog-events' resource model represents a view of information about getting logs from the device. It consists of the following fields:

Field NameTypeRead OnlyGETPUT / POSTDescription
clientIdStringNY Y The ID of the client.
queueUrlStringNY Y A fully qualified queue URL where job progress notifications will be sent.
deviceget-syslog-events.syslogDevices[]NY Y * A type to represent the devices
text-patternString[]NY Y * A type to represent the text-patterns

get-syslog-events.syslogDevices

The 'device' field of type 'syslogDevices' represent a view of information about the device for which syslogs have to be fetched. It consists of the following fields:

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@hrefString(URI)NY Y NNLink to an external syslogDevices. Here, href points to the syslogDevices in the primary syslogDevices collection.

high-cpu-usage (vnd.net.juniper.space.fabric-management.high-cpu-usage;version=3)

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this high-cpu-usage node in the current node context. This link can be used to retrieve or operate on the currently referenced high-cpu-usage in the tree path.

Hyperlink Template: /api/space/fabric-management/high-cpu-usages/{*ID}.
@totalIntegerYY N Total number of high-cpu-usage in the API result set. If paging parameters are used in the query to limit the result set size, then total represents the total number of high-cpu-usage in all the pages of the result set.
@hrefString(URI)YY N Link to an external high-cpu-usage. Here, href points to the high-cpu-usage in the primary high-cpu-usages collection.

Hyperlink Template: /api/space/fabric-management/high-cpu-usages/{*ID}.
*idIntegerYY N ID.
node-nameStringNY Y * Logical name assigned to the node.
node-ipStringYY N IPv4 address for the node.
node-ipv6StringYY N IPv6 address for the node.
average-cpu-utilizationDoubleNY Y * Average load on the CPU of the node.
start-timeStringNY Y * Time from when the node reported high CPU usage.
end-timeStringNY Y * Time to when the node reported high CPU usage.
durationLongNY Y * Total duration of high CPU usage on the node in minutes.
fabric-nodehigh-cpu-usage.fabricNodeNY Y *  

high-cpu-usage.fabricNode

Field NameTypeRead OnlyGETPUT / POSTDescription
@hrefString(URI)NY Y * Link to an external fabricNode. Here, href points to the fabricNode in the primary fabricNode collection.

Hyperlink Template: /api/space/fabric-management/fabric-nodes/{*ID}.
idIntegerYY N FabricNode ID.
nameStringYY N FabricNode Name.

high-cpu-usages (vnd.net.juniper.space.fabric-management.high-cpu-usages;version=3)

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this high-cpu-usages node in the current node context. This link can be used to retrieve or operate on the currently referenced high-cpu-usages in the tree path.
@totalIntegerYY N Total number of high-cpu-usages in the API result set. If paging parameters are used in the query to limit the result set size, then total represents the total number of high-cpu-usages in all the pages of the result set.
high-cpu-usagehigh-cpu-usages.highCPUUsage[]NY Y *  

high-cpu-usages.highCPUUsage

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)YY N NNLink to this highCPUUsage node in the current node context. This link can be used to retrieve or operate on the currently referenced highCPUUsage in the tree path.

Hyperlink Template: /api/space/fabric-management/high-cpu-usages/{*ID}.
@hrefString(URI)YY N NNLink to an external highCPUUsage. Here, href points to the highCPUUsage in the primary high-cpu-usages collection.

Hyperlink Template: /api/space/fabric-management/high-cpu-usages/{*ID}.
idIntegerYY N NNID.
node-nameStringNY Y YYLogical name assigned to the node.
node-ipStringYY N YYIPv4 address for the node.
node-ipv6StringYY N YYIPv6 address for the node.
average-cpu-utilizationDoubleNY Y * YYAverage load on the CPU of the node.
start-timeStringNY Y YYTime from when the node reported high CPU usage.
end-timeStringNY Y YYTime to when the node reported high CPU usage.
durationLongNY Y NNTotal duration of high CPU usage on the node in minutes.

image (vnd.net.juniper.space.user-management.image;version=3)

Field NameTypeRead OnlyGETPUT / POSTDescription
base64-valueStringNY Y * Image as base64 encoded string.

import-roles-request (vnd.net.juniper.space.user-management.import-roles-request;version=3)

Field NameTypeRead OnlyGETPUT / POSTDescription
rolesimport-roles-request.rolesNY Y *  

import-roles-request.roles

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this roles node in the current node context. This link can be used to retrieve or operate on the currently referenced roles in the tree path.
roleimport-roles-request.roles.role[]NY Y *  

import-roles-request.roles.role

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@hrefString(URI)YY N NNLink to an external role. Here, href points to the role in the primary roles collection.

Hyperlink Template: /api/space/user-management/roles/{*ID}.
predefinedBooleanYY N YYPredefined.

Default: false.
idIntegerYY N YYRole ID.
titleStringYY N YYTitle.
descriptionStringNY Y YYDescription.
sharableBooleanYY N NNSharable.
capabilitiesimport-roles-request.roles.role.availableCapsNY Y NN 
lessTasksStringNY Y NNLess Tasks.

import-roles-request.roles.role.availableCaps

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this availableCaps node in the current node context. This link can be used to retrieve or operate on the currently referenced availableCaps in the tree path.
@totalIntegerYY N Total number of gen_import-roles-request-roles-roles-available-caps in the API result set. If paging parameters are used in the query to limit the result set size, then total represents the total number of gen_import-roles-request-roles-roles-available-caps in all the pages of the result set.
capabilityimport-roles-request.roles.role.availableCaps.capability[]NY Y *  

import-roles-request.roles.role.availableCaps.capability

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@hrefString(URI)YY N NNLink to an external capability. Here, href points to the capability in the primary capability collection.

Hyperlink Template: /api/space/user-management/capabilities/{*ID}.
idIntegerNY Y * NNCap ID.
nameStringNY Y NNCapability Name.

install-schemas-svn-request (vnd.net.juniper.space.schema-service.install-schemas-svn-request;version=1)

Use this API to download the schema from the SVN repository. Note: In order to install the schema from the SVN repository, you must first configure a connection to the SVN Repository using the Space UI. This is described in the Updating a DMI Schema document.

Field NameTypeRead OnlyGETPUT / POSTDescription
schemasinstall-schemas-svn-request.schemasNY Y *  

install-schemas-svn-request.schemas

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this schemas node in the current node context. This link can be used to retrieve or operate on the currently referenced schemas in the tree path.
schemainstall-schemas-svn-request.schemas.schema[]NY Y *  

install-schemas-svn-request.schemas.schema

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)YY N NNLink to this schema node in the current node context. This link can be used to retrieve or operate on the currently referenced schema in the tree path.

Hyperlink Template: /api/space/schema-serviceupload-tgz-schema-file.
device-familyStringNY Y * NNDevice Family. This property must be specified when installing schemas. Please refer to Supported Device Families for a list of supported device families. First select the device-family, which will show a page containing the list of releases which are supported for that device-family. At the time of this publication, the following device families where supported: bxos, ive-ic, ive-sa, junos, junos-es, junos-ex, junos-mag, junos-qf, junos-qfx, mssos, tcaos, vse-mcg.
releaseStringNY Y * NNRelease. This property must be specified when installing schemas. Please refer to Supported Device Families for a list of supported releases. First select the device-family, which will show a page containing the list of releases which are supported for that device-family.

install-schemas-tgz-request (vnd.net.juniper.space.schema-service.install-schemas-tgz-request;version=1)

Install schemas from a disk location on the Space server.

Field NameTypeRead OnlyGETPUT / POSTDescription
schemasinstall-schemas-tgz-request.schemas2NY Y * List of schemas to install. All schemas must be installed from a disk location on the server.

install-schemas-tgz-request.schemas2

List of schemas to install. All schemas must be installed from a disk location on the server.

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this schemas2 node in the current node context. This link can be used to retrieve or operate on the currently referenced schemas2 in the tree path.
schemainstall-schemas-tgz-request.schemas2.schema[]NY Y * Single schema to install from a disk location on the Space Server.

install-schemas-tgz-request.schemas2.schema

Single schema to install from a disk location on the Space Server.

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)YY N NNLink to this schema node in the current node context. This link can be used to retrieve or operate on the currently referenced schema in the tree path.

Hyperlink Template: /api/space/schema-serviceupload-tgz-schema-file.
schema-locationStringNY Y * NNSchema Location on the Space Server. This location will be returned by the /api/space/schema-serviceupload-tgz-schema-file API.
device-familyStringNY Y * NNDevice Family. This property must be specified when installing schemas. Please refer to Supported Device Families for a list of supported device families. At the time of this publication, the following device families where supported:

bxos, ive-ic, ive-sa, junos, junos-es, junos-ex, junos-mag, junos-qf, junos-qfx, mssos, tcaos, vse-mcg.
releaseStringNY Y * NNRelease. This property must be specified when installing schemas. Please refer to Supported Releases for a list of supported device families and releases.

job (vnd.net.juniper.space.job-management.job;version=3)

Field NameTypeRead OnlyGETPUT / POSTPATCHDescription
@uriString(URI)NY Y NLink to this job node in the current node context. This link can be used to retrieve or operate on the currently referenced job in the tree path.

Hyperlink Template: /api/space/job-management/jobs/{*ID}.
@hrefString(URI)YY N NLink to an external job. Here, href points to the job in the primary job collection.

Hyperlink Template: /api/space/job-management/jobs/{*ID}.
*idIntegerYY N NThe ID of the job.
nameStringYY N NThe name of the job.
percent-completeDoubleYY N NThe percentage of job completion.
mo-stateStringNY Y YMo State.
job-stateenum(job-state)YY N NThe current state of the job.

Possible Values:
SCHEDULED 
QUEUED 
STARTING 
INPROGRESS 
DONE 
CANCELLING 
DISABLED 
.
job-statusenum(job-status)YY N NThe current status of the job.

Possible Values:
UNDETERMINED 
INCOMPLETE 
FAILURE 
SUCCESS 
CANCELLED 
DEPRECATED 
.
job-typeStringYY N NThe type of job.
job-params-summaryStringYY N NThe summary of job parameters.
job-parameter-dataStringYY N NThe parameter with which the job is triggered.
summaryStringYY N NA summary of the job.
scheduled-start-timeStringYY N NThe time that the job is scheduled to start.
start-timeStringYY N NThe time at which the job started.
end-timeStringYY N NThe time at which the job ended.
ownerStringNY Y * YThe user related to this job. This user is reffered as the owner of the job.
repeat-cronStringYY N NIf recurrence is set as raw cron send it back for rest.
schedule-stringStringYY N NA string representation of the job schedule.
retry-group-idIntegerYY N NRetry Group ID.
retry-groupjob.retryGroupYY N NRetry group job details.
previous-retry-idIntegerYY N NPrevious retry job ID.
previous-retryjob.previousRetryYY N N 
detail-linkjob.detailLinkYY N N 
retry-supportedBooleanYY N NThis flag is to represent the current job does supports retry or not.

Default: false.
retry-job-linkjob.retryJobLinkYY N N 
supports-recurrenceBooleanYY N NSupports Recurrence.

Default: false.
domain-idIntegerYY N NThe domain id of the job.
domain-nameStringYY N NThe domain name of the job.
domainStringYY N N

Hyperlink Template: /api/space/domain-management/domains/{*ID}.
cancelStringYY N NCancel Job

Hyperlink Template: /api/space/job-management/jobs/{*ID}/cancel.
progress-updateStringYY N NJob's progress update

Hyperlink Template: /api/space/job-management/jobs/{*ID}/progress-update.
reschedule-jobStringYY N NReschedule this job

Hyperlink Template: /api/space/job-management/jobs/{*ID}/reschedule-job.

job.retryGroup

Retry group job details

Field NameTypeRead OnlyGETPUT / POSTDescription
@hrefString(URI)NY Y * Link to an external retryGroup. Here, href points to the retryGroup in the primary retryGroup collection.

Hyperlink Template: /api/space/job-management/jobs/{*ID}.
idIntegerYY N The ID of the job.
nameStringYY N MonitorableTaskInstanceManagedObject Name.

job.previousRetry

Field NameTypeRead OnlyGETPUT / POSTDescription
@hrefString(URI)NY Y * Link to an external previousRetry. Here, href points to the previousRetry in the primary previousRetry collection.

Hyperlink Template: /api/space/job-management/jobs/{*ID}.
idIntegerYY N The ID of the job.
nameStringYY N MonitorableTaskInstanceManagedObject Name.

job.detailLink


job.retryJobLink

Job_patch (vnd.net.juniper.space.job-management.job_patch;version=3)

jobs (vnd.net.juniper.space.job-management.jobs;version=3)

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)NY Y Link to this jobs node in the current node context. This link can be used to retrieve or operate on the currently referenced jobs in the tree path.
@totalIntegerYY N Total number of jobs in the API result set. If paging parameters are used in the query to limit the result set size, then total represents the total number of jobs in all the pages of the result set.
jobjobs.monitorableTaskInstanceManagedObject[]NY Y *  

jobs.monitorableTaskInstanceManagedObject

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)NY Y NNLink to this monitorableTaskInstanceManagedObject node in the current node context. This link can be used to retrieve or operate on the currently referenced monitorableTaskInstanceManagedObject in the tree path.

Hyperlink Template: /api/space/job-management/jobs/{*ID}.
@hrefString(URI)YY N NNLink to an external monitorableTaskInstanceManagedObject. Here, href points to the monitorableTaskInstanceManagedObject in the primary monitorableTaskInstanceManagedObject collection.

Hyperlink Template: /api/space/job-management/jobs/{*ID}.
idIntegerYY N YYThe ID of the job.
nameStringYY N YYThe name of the job.
percent-completeDoubleYY N YYThe percentage of job completion.
mo-stateStringNY Y YYMo State.
job-stateenum(job-state)YY N YYThe current state of the job.

Possible Values:
SCHEDULED 
QUEUED 
STARTING 
INPROGRESS 
DONE 
CANCELLING 
DISABLED 
.
job-statusenum(job-status)YY N YYThe current status of the job.

Possible Values:
UNDETERMINED 
INCOMPLETE 
FAILURE 
SUCCESS 
CANCELLED 
DEPRECATED 
.
job-typeStringYY N YYThe type of job.
job-params-summaryStringYY N NNThe summary of job parameters.
job-parameter-dataStringYY N NNThe parameter with which the job is triggered.
summaryStringYY N NYA summary of the job.
scheduled-start-timeStringYY N YYThe time that the job is scheduled to start.
start-timeStringYY N YYThe time at which the job started.
end-timeStringYY N YYThe time at which the job ended.
ownerStringNY Y * YYThe user related to this job. This user is reffered as the owner of the job.
schedule-stringStringYY N NYA string representation of the job schedule.
retry-group-idIntegerYY N YYRetry Group ID.
previous-retry-idIntegerYY N YYPrevious retry job ID.
retry-supportedBooleanYY N NNThis flag is to represent the current job does supports retry or not.

Default: false.
domain-idIntegerYY N NYThe domain id of the job.
domain-nameStringYY N NNThe domain name of the job.
domainStringYY N NN

Hyperlink Template: /api/space/domain-management/domains/{*ID}.

job-types (vnd.net.juniper.space.job-management.job-types;version=3)

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this job-types node in the current node context. This link can be used to retrieve or operate on the currently referenced job-types in the tree path.
@totalIntegerYY N Total number of job-types in the API result set. If paging parameters are used in the query to limit the result set size, then total represents the total number of job-types in all the pages of the result set.
job-typeString[]NY Y * Job Type.

managed-element (vnd.net.juniper.space.managed-domain.managed-element;version=1)

The 'managed-element resource model contains data about a single managed element. This resource model consists of the following fields:

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)NY Y Link to this managed-element node in the current node context. This link can be used to retrieve or operate on the currently referenced managed-element in the tree path.
devicemanaged-element.deviceNY Y Information about a device to which the managed element is attached.
ptpsmanaged-element.physicalTerminationPointsNY Y The signal termination and assurance functions supported by a port. The PTP is a termination point that includes a physical layer rate (see R_TMF518_NRB_I_0003). The PTP does not represent the physical connector itself. Examples of PTPs are T1 ports, T3 ports, OC-N optical ports, and so on.
loopbackptp-refNY Y Information about connection termination points that can be accessed through /api/space/managed-domain/ptps/{id}. The jsPhysicalTerminationPoint resource is accessed through /api/space/managed-domain/managed-elements/{id}/ptps/{ptpId}. The jsPrimaryPhysicalTerminationPoint resource is different from jsPhysicalTerminationPoint in two ways. First, it has extra information about CTPs. Second, it has no HREF and only an URI is present because it contains all possible information about a PTP. The jsPhysicalTerminationPoint resource lacks CTP information and contains an HREF to the API /api/space/managed-domain/ptps/{id}.
ipAddrStringNY Y The IP address of the managed element
idIntegerNY Y * The ID of the managed element
equipment-holdersStringNY Y A link to equipment holders.
multilayer-subnetworksStringNY Y A link to the subnetworks.
routing-instancesStringNY Y A link to the routing instances.
software-identitiesStringNY Y A link to the software identities.
routing-optionsStringNY Y A link to the routing options.
vlansStringNY Y A link to the VLANs.
routing-enginesStringNY Y A link to the routing engines.
virtual-chassisStringNY Y A link to the virtual chassis check.

managed-element.physicalTerminationPoints

The 'ptps' field contains information about PTPs inside a managed element and represents pull-through data. It is a complex type consisting of the following fields:

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)NY Y Link to this physicalTerminationPoints node in the current node context. This link can be used to retrieve or operate on the currently referenced physicalTerminationPoints in the tree path.
ptpmanaged-element.physicalTerminationPoints.physicalTerminationPoint[]NY Y A collection of physical termination points

managed-element.physicalTerminationPoints.physicalTerminationPoint

The 'ptp' type contains information about a single PTP and the pull-through fields.

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@hrefString(URI)NY Y NNLink to an external physicalTerminationPoint. Here, href points to the physicalTerminationPoint in the primary physicalTerminationPoint collection.
@uriString(URI)NY Y NNLink to this physicalTerminationPoint node in the current node context. This link can be used to retrieve or operate on the currently referenced physicalTerminationPoint in the tree path.
nameStringNY Y NN The name of the termination point
typeStringNY Y NN The 'ptp' type
encapsulationStringNY Y NNThe encapsulation of the PTP
taggingStringNY Y NNNot supported
adminStatusStringNY Y NNThe administration status.
operationStatusStringNY Y NNThe operation status of the termination point.
speedIntegerNY Y NNthe speed of the termination point.
mtuIntegerNY Y NNThe maximum transmission unit (MTU) size on the physical interface
lacpBundleStringNY Y NNThe aggregated Ethernet interface to which this PTP belongs
deviceIdStringNY Y NNDevice ID
ptpIdIntegerNY Y * NNThe ID of the PTP.
idIntegerNY Y * NNThe ID of the managed element

managed-element.device

The 'device' type contains data about the device to which the managed element belongs

Field NameTypeRead OnlyGETPUT / POSTDescription
@hrefString(URI)NY Y Link to an external device. Here, href points to the device in the primary device collection.
deviceFamilyStringNY Y The device family to which the device belongs
OSVersionStringNY Y The Junos OS version.
platformStringNY Y The platform on which the device exists
serialNumberStringNY Y The serial number of the device.
nameStringNY Y The name of the device.
hostNameStringNY Y The host name of the device
connectionstatusStringNY Y The connection status of the device
idIntegerNY Y * The ID of the device
ipAddrStringNY Y The IP address of the device
otpStringNY Y A one time password used for the device connection
managedStatusStringNY Y The managed status of the device

managed-elements (vnd.net.juniper.space.device-management.managed-elements;version=1)

The 'managed-elements' resource model represents a view of information about the managed elements of a device. It consists of the following fields:

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)NY Y * Link to this managed-elements node in the current node context. This link can be used to retrieve or operate on the currently referenced managed-elements in the tree path.
managed-elementmanaged-elements.jSManagedElement[]NY Y The type representing managed elements for the specified device.

managed-elements.jSManagedElement

The 'managed-element' field of type 'jsManagedElement' represents a collection of management elements for a device. It consists of the following fields:

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@hrefString(URI)NY Y * NNLink to an external jSManagedElement. Here, href points to the jSManagedElement in the primary jSManagedElement collection.
@keyIntegerNY Y * NN Unique identifier for the managed element.
ipAddrStringNY Y NN IP address of the device

managed-elements (vnd.net.juniper.space.managed-domain.managed-elements;version=1)

The 'managed-elements' resource model represents a user's view of all managed-elements inside the space. It consists of the following fields:

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)NY Y Link to this managed-elements node in the current node context. This link can be used to retrieve or operate on the currently referenced managed-elements in the tree path.
@sizeIntegerNY Y The number of managed elements
managed-elementmanaged-elements.managedElementDTO[]NY Y The managed element object represents the Junos OS view of a network element. It is a single element inside the primary collection of a managed-element.

managed-elements.managedElementDTO

The managed element object represents the Junos OS view of a network element. It is a single element inside the primary collection of a managed-element.

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)NY Y NNLink to this managedElementDTO node in the current node context. This link can be used to retrieve or operate on the currently referenced managedElementDTO in the tree path.
@hrefString(URI)NY Y NNLink to an external managedElementDTO. Here, href points to the managedElementDTO in the primary managedElementDTO collection.
@keyIntegerNY Y NN The primary ID of the managed element
ipAddrStringNY Y NN The IP address of the managed element

managed-elements (vnd.net.juniper.space.managed-domain.managed-elements;version=1)

The 'managed-elements' resource model represents a user's view of all managed-elements inside the space. It consists of the following fields:

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)NY Y Link to this managed-elements node in the current node context. This link can be used to retrieve or operate on the currently referenced managed-elements in the tree path.
@sizeIntegerNY Y The number of managed elements
managed-elementmanaged-elements.managedElementDTO[]NY Y The managed element object represents the Junos OS view of a network element. It is a single element inside the primary collection of a managed-element.

managed-elements.managedElementDTO

The managed element object represents the Junos OS view of a network element. It is a single element inside the primary collection of a managed-element.

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)NY Y NNLink to this managedElementDTO node in the current node context. This link can be used to retrieve or operate on the currently referenced managedElementDTO in the tree path.
@hrefString(URI)NY Y NNLink to an external managedElementDTO. Here, href points to the managedElementDTO in the primary managedElementDTO collection.
@keyIntegerNY Y NN The primary ID of the managed element
ipAddrStringNY Y YY The IP address of the managed element

managed-status (vnd.net.juniper.space.device-management.managed-status;version=1)

The 'managed-status' resource model represents a view of the information about the managed status of the device. It consists of the following fields:

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)NY Y * Link to this managed-status node in the current node context. This link can be used to retrieve or operate on the currently referenced managed-status in the tree path.
statusStringNY Y Managed status of the device.

match-cli-configlets-by-context-request (vnd.net.juniper.space.configuration-management.match-cli-configlets-by-context-request;version=3)

It contains list of contexts.Context is the Xpath based on which the configlets will be fetched. The context value should be same as in view context link in apply configlet window.
Example : /device[name="EX4200-200"]/interface-information/physical-interface

Field NameTypeRead OnlyGETPUT / POSTDescription
context-listmatch-cli-configlets-by-context-request.contextListsNY Y * List of context details.

match-cli-configlets-by-context-request.contextLists

List of context

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this contextLists node in the current node context. This link can be used to retrieve or operate on the currently referenced contextLists in the tree path.
contextString[]NY Y * Context Context is the Xpath based on which the configlets will be fetched. The context value should be same as in view context link in apply configlet window
Example : /device[name="EX4200-200"]/interface-information/physical-interface.

match-cli-configlets-by-context-response (vnd.net.juniper.space.configuration-management.match-cli-configlets-by-context-response;version=3)

Configlet List
Configlets which are matched by the given context list

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this match-cli-configlets-by-context-response node in the current node context. This link can be used to retrieve or operate on the currently referenced match-cli-configlets-by-context-response in the tree path.
cli-configletsmatch-cli-configlets-by-context-response.cliConfigletListsNY Y List of configlets.

match-cli-configlets-by-context-response.cliConfigletLists

List of configlets

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this cliConfigletLists node in the current node context. This link can be used to retrieve or operate on the currently referenced cliConfigletLists in the tree path.
cli-configletmatch-cli-configlets-by-context-response.cliConfigletLists.cliConfigurationTemplate[]NY Y * Configlet details.

match-cli-configlets-by-context-response.cliConfigletLists.cliConfigurationTemplate

Configlet details

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@hrefString(URI)YY N NNLink to an external cliConfigurationTemplate. Here, href points to the cliConfigurationTemplate in the primary cli-configlets collection.

Hyperlink Template: /api/space/configuration-management/cli-configlets/{*ID}.
idIntegerYY N NNConfiglet ID
Unique key of the configlet. Through this ID configlet could be accessed.
nameStringNY Y * YYConfiglet Name
The Name cannot exceed 255 characters. Allowable characters include dash (-), underscore (_), letters, and numbers and period (.).
You cannot have two configlets with the same name in one domain.
latest-versionStringYY N YYLatest Version
Latest version of the configlet.

Default: "1.0".
categoryStringNY Y YYCategory
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. Allowable characters include dash (-), underscore (_), letters, and numbers and period (.).
descriptionStringNY Y NNDescription
Description of the configlet and it cannot exceed 2500 characters.
device-familyStringNY Y * YYDevice Family
The device family for which the configlet will be applicable for.
execution-typeenum(execution-type)NY Y YYTypes of Execution
There are two types of execution types. Based on this type configlet would be available to apply on number of selected elements.
TypeDescription
SINGLEThe configlet can be applied to only one element at a time
GROUPEDThe configlet can be applied to multiple elements(devices) at a time
.

Possible Values:
SINGLESingle
GROUPEDGrouped

Default: SINGLE.
reference-numberIntegerNY Y YYReference Number
Reference Number the configlet belongs to and it is an arbitrary value, which can be used for filtering.

Min: 1 Max: 65535.
domain-idIntegerYY N NYDomain ID
It specifies the domain ID for which this configlet belongs to.
domain-nameStringYY N NNDomain Name
Name of the domain for which the configlet belongs to.
creation-timeDateYY N YYCreation Time
The time when the configlet was created.
last-updated-timeDateYY N YYLast Modified Time
The time when the configlet was updated at last.
last-modified-byStringYY N YYLast Modified user
The name of the user who modified the configlet at last.

match-scripts-by-context-request (vnd.net.juniper.space.script-management.match-scripts-by-context-request;version=3)

It contains list of contexts.Context is the Xpath based on which the configlets will be fetched. The context value should be same as in view context link in apply configlet/execute script window.
Example : /device[name="EX4200-200"]/interface-information/physical-interface

Field NameTypeRead OnlyGETPUT / POSTDescription
context-listmatch-scripts-by-context-request.contextListsNY Y * Context list details.

match-scripts-by-context-request.contextLists

Context list details

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this contextLists node in the current node context. This link can be used to retrieve or operate on the currently referenced contextLists in the tree path.
contextString[]NY Y * Context
Context is the Xpath based on which the configlets will be fetched. The context value should be same as in view context link in apply configlet/execute script window.
Example : /device[name="EX4200-200"]/interface-information/physical-interface.

match-scripts-by-context-response (vnd.net.juniper.space.script-management.match-scripts-by-context-response;version=3)

List of scripts based on the context list

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this match-scripts-by-context-response node in the current node context. This link can be used to retrieve or operate on the currently referenced match-scripts-by-context-response in the tree path.
scriptsmatch-scripts-by-context-response.scriptListsNY Y List of Scripts.

match-scripts-by-context-response.scriptLists

List of Scripts

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this scriptLists node in the current node context. This link can be used to retrieve or operate on the currently referenced scriptLists in the tree path.
scriptmatch-scripts-by-context-response.scriptLists.script[]NY Y * Script details.

match-scripts-by-context-response.scriptLists.script

Script details

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)YY N NNLink to this script node in the current node context. This link can be used to retrieve or operate on the currently referenced script in the tree path.

Hyperlink Template: /api/space/script-management/scripts.
@hrefString(URI)YY N NNLink to an external script. Here, href points to the script in the primary scripts collection.

Hyperlink Template: /api/space/script-management/scripts/{*ID}.
idIntegerYY N NNScript ID.
script-nameStringNY Y NNName of the Script.
domain-idIntegerYY N NYDomain ID.
domain-nameStringYY N NNDomain Name the script belongs to.
display-nameStringNY Y NNDisplay Name of the script.
typeStringNY Y NNScript Type
Type of Script could be one among the following
1. Commit Script 2. Op Script 3. Event Script.

Default: "Op Script".
categoryStringNY Y NNCategory Category is an arbitrary value used for sorting/filtering.
execution-typeStringNY Y NNExecution Type
Type of execution could be one among the following
1. Device 2. Local.

Default: "Device".
formatStringNY Y NNFormat
Format could be one of the following
1. SLAX 2. XSL.

Default: "SLAX".
lastest-revisionStringYY N NNLastest Revision.
creation-timeDateYY N NNCreation Time.
descriptionStringNY Y NNDescription.
last-update-timeDateYY N NNLast Update Time.

menu-statuses (vnd.net.juniper.space.user-management.menu-statuses;version=3)


menu-statuses.menu

menu-status-request (vnd.net.juniper.space.user-management.menu-status-request;version=3)


menu-status-request.taskNames


menu-status-request.selectedUserLists

modeled-instance (vnd.net.juniper.space.device-management.modeled-device-management.modeled-instance;version=1)

Field NameTypeRead OnlyGETPUT / POSTDescription
@hrefString(URI)YY N Link to an external modeled-instance. Here, href points to the modeled-instance in the primary modeled-instance collection.

Hyperlink Template: /api/space/device-management/modeled-device-management/modeled-instances/{*ID}.
@uriString(URI)YY N Link to this modeled-instance node in the current node context. This link can be used to retrieve or operate on the currently referenced modeled-instance in the tree path.

Hyperlink Template: /api/space/device-management/modeled-device-management/modeled-instances/{*ID}.
*idIntegerNY Y ID of the modeled instance.
nameStringNY Y * Name of the modeled instance.
descriptionStringNY Y Description of the modeled instance.
device-familyStringNY 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-typeenum(connection-profile-type)NY Y The Connection type (for example; DHCP, PPPoA, PPPoE, Static).

Possible Values:
Static 
DHCP 
PPPoA 
PPPoE 
NONENone
.
platformStringNY Y * Platform of the devices.
device-countIntegerNY Y Number of devices, This will be overridden if deviceUnits are explicitly defined.

Default: 1.
devicesStringYY N View modeled instance devices.

Hyperlink Template: /api/space/device-management/modeled-device-management/modeled-instances/{*ID}/devices.
configletsStringYY N Configlet for the devices

Hyperlink Template: /api/space/device-management/modeled-device-management/modeled-instances/{*ID}/configlets.
add-more-devicesStringYY N Add More devices

Hyperlink Template: /api/space/device-management/modeled-device-management/modeled-instances/{*ID}/add-more-devices.

modeled-instance-activate-later (vnd.net.juniper.space.device-management.modeled-device-management.modeled-instance-activate-later;version=2)

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this modeled-instance-activate-later node in the current node context. This link can be used to retrieve or operate on the currently referenced modeled-instance-activate-later in the tree path.
nameStringNY Y * Name of the modeled instance.
descriptionStringNY Y Description for modeled instance.
tag-nameStringNY Y Tag devices with this tag.
number-of-devicesIntegerNY Y Number of devices, This will be overridden if deviceUnits are explicitly defined.

Default: 1 Min: 1 Max: 200.
platformStringNY Y * Platform of the devices.
templatemodeled-instance-activate-later.configTemplateInfoNY Y Device template href.
device-imagemodeled-instance-activate-later.deviceImageNY Y Device image href.
devicesmodeled-instance-activate-later.deviceUnitsNY Y List of modeled device which contains details like device-name, platform, os-version, serial-number.
snmp-settingmodeled-instance-activate-later.snmpSettingRESTNY Y Parameters to configure SNMPV1/V2C/V3.

modeled-instance-activate-later.configTemplateInfo

Device template href.

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this configTemplateInfo node in the current node context. This link can be used to retrieve or operate on the currently referenced configTemplateInfo in the tree path.
@hrefString(URI)NY Y * Link to an external configTemplateInfo. Here, href points to the configTemplateInfo in the primary configTemplateInfo collection.

Hyperlink Template: /api/space/config-template-management/config-templates/{*ID}.
idIntegerYY N Id of the template.
nameStringYY N Name of the template.

modeled-instance-activate-later.deviceImage

Device image href.

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this deviceImage node in the current node context. This link can be used to retrieve or operate on the currently referenced deviceImage in the tree path.
@hrefString(URI)NY Y * Link to an external deviceImage. Here, href points to the deviceImage in the primary deviceImage collection.

Hyperlink Template: /api/space/software-management/packages/{*ID}.
idIntegerYY N Id of the device image.
nameStringYY N Name of the device image.

modeled-instance-activate-later.deviceUnits

List of modeled device which contains details like device-name, platform, os-version, serial-number

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this deviceUnits node in the current node context. This link can be used to retrieve or operate on the currently referenced deviceUnits in the tree path.
devicemodeled-instance-activate-later.deviceUnits.deployDeviceUnit[]NY Y * Modeled device which contains details like device-name, platform, os-version, serial-number.

modeled-instance-activate-later.deviceUnits.deployDeviceUnit

Modeled device which contains details like device-name, platform, os-version, serial-number

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)YY N NNLink to this deployDeviceUnit node in the current node context. This link can be used to retrieve or operate on the currently referenced deployDeviceUnit in the tree path.
device-nameStringNY Y NNName of the device.
platformStringNY Y NNPlatform of the device.

modeled-instance-activate-later.snmpSettingREST

Parameters to configure SNMPV1/V2C/V3

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this snmpSettingREST node in the current node context. This link can be used to retrieve or operate on the currently referenced snmpSettingREST in the tree path.
snmp-v1-settingmodeled-instance-activate-later.snmpSettingREST.snmpV1SettingRESTNY Y SNMPV1 parameters used for polling.
snmp-v2c-settingmodeled-instance-activate-later.snmpSettingREST.snmpV2CSettingRESTNY Y SNMPV2C parameters used for polling.
snmp-v3-settingmodeled-instance-activate-later.snmpSettingREST.snmpV3SettingRESTNY Y SNMPV3 parameters used for polling.

modeled-instance-activate-later.snmpSettingREST.snmpV1SettingREST

SNMPV1 parameters used for polling

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this snmpV1SettingREST node in the current node context. This link can be used to retrieve or operate on the currently referenced snmpV1SettingREST in the tree path.
community-nameStringNY Y Community name for SNMP V1.

Default: "public".

modeled-instance-activate-later.snmpSettingREST.snmpV2CSettingREST

SNMPV2C parameters used for polling

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this snmpV2CSettingREST node in the current node context. This link can be used to retrieve or operate on the currently referenced snmpV2CSettingREST in the tree path.
community-nameStringNY Y Community name for SNMP V2C.

Default: "public".

modeled-instance-activate-later.snmpSettingREST.snmpV3SettingREST

SNMPV3 parameters used for polling

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this snmpV3SettingREST node in the current node context. This link can be used to retrieve or operate on the currently referenced snmpV3SettingREST in the tree path.
user-nameStringNY Y * SNMP V3 user name.
authentication-typeenum(authentication-type)NY 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:
MD5 
SHA1 
NONENone

Default: MD5.
authentication-passwordStringNY Y SNMP V3 User's authentication password
The password should contain minimum of 8 characters and maximum 1024 characters.
privacy-typeenum(privacy-type)NY Y SNMP V3 Privacy protocol
If the privacy-type is NONE then the field privacy-password is not applicable.

Possible Values:
AES128 
AES192 
AES256 
DES 
NONENone

Default: DES.
privacy-passwordStringNY Y SNMP V3 User's privacy password
The password should contain minimum of 8 characters and maximum 1024 characters.

modeled-instance-activate-now (vnd.net.juniper.space.device-management.modeled-device-management.modeled-instance-activate-now;version=2)

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this modeled-instance-activate-now node in the current node context. This link can be used to retrieve or operate on the currently referenced modeled-instance-activate-now in the tree path.
nameStringNY Y * Name of the modeled instance.
descriptionStringNY Y Description for modeled instance.
tag-nameStringNY Y Tag devices with this tag.
platformStringNY Y * Platform of the devices.
number-of-devicesIntegerNY Y Number of devices, This will be overridden if deviceUnits are explicitly defined.

Default: 1 Min: 1 Max: 200.
templatemodeled-instance-activate-now.configTemplateInfoNY Y Device template href.
device-imagemodeled-instance-activate-now.deviceImageNY Y Device image href.
activation-parametersmodeled-instance-activate-now.deployInstanceActiveNowMORESTNY Y * Parameters for activating model device connection like device-credentials, connection establishment details and validation details.
devicesmodeled-instance-activate-now.deviceUnitsNY Y List of modeled device which contains details like device-name, platform, os-version, serial-number.
snmp-settingmodeled-instance-activate-now.snmpSettingRESTNY Y Parameters for SNMP settings like SNMP V1/V2C/V3.

modeled-instance-activate-now.configTemplateInfo

Device template href.

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this configTemplateInfo node in the current node context. This link can be used to retrieve or operate on the currently referenced configTemplateInfo in the tree path.
@hrefString(URI)NY Y * Link to an external configTemplateInfo. Here, href points to the configTemplateInfo in the primary configTemplateInfo collection.

Hyperlink Template: /api/space/config-template-management/config-templates/{*ID}.
idIntegerYY N Id of the template.
nameStringYY N Name of the template.

modeled-instance-activate-now.deviceImage

Device image href.

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this deviceImage node in the current node context. This link can be used to retrieve or operate on the currently referenced deviceImage in the tree path.
@hrefString(URI)NY Y * Link to an external deviceImage. Here, href points to the deviceImage in the primary deviceImage collection.

Hyperlink Template: /api/space/software-management/packages/{*ID}.
idIntegerYY N Id of the device image.
nameStringYY N Name of the device image.

modeled-instance-activate-now.deployInstanceActiveNowMOREST

Parameters for activating model device connection like device-credentials, connection establishment details and validation details

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this deployInstanceActiveNowMOREST node in the current node context. This link can be used to retrieve or operate on the currently referenced deployInstanceActiveNowMOREST in the tree path.
user-nameStringNY Y * Username to authenticate with the device.
key-basedBooleanNY Y Should key based authentication be performed.

Default: false.
passwordStringNY Y Password to authenticate with the device, mandatory if key-based is not set to true.
serial-number-validationBooleanNY Y Perform serial Number validation while adding device to space.

Default: false.
host-name-validationBooleanNY Y Perform host name validation while adding device to space.

Default: false.
connection-profilemodeled-instance-activate-now.deployInstanceActiveNowMOREST.connectionProfileMORESTNY 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-typeenum(configuration-update-type)NY Y Configuration update type, if Automatic, the configuration will be updated once the device connects space.

Possible Values:
AUTOMATICAutomatic
MANUALManual
NOT_APPICABLENot Applicable

Default: AUTOMATIC.

modeled-instance-activate-now.deployInstanceActiveNowMOREST.connectionProfileMOREST

Connection-profile which Contains connection-establishment parameters like ip details, NAT details, connection-type(DHCP,ADSL,PPPoaA,PPPoE) and its sub-parameters

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this connectionProfileMOREST node in the current node context. This link can be used to retrieve or operate on the currently referenced connectionProfileMOREST in the tree path.

Hyperlink Template: /api/space/device-management/modeled-device-management/connection-profile-rests/{*ID}.
@hrefString(URI)NY Y * Link to an external connectionProfileMOREST. Here, href points to the connectionProfileMOREST in the primary connectionProfileMOREST collection.

Hyperlink Template: /api/space/device-management/modeled-device-management/connection-profiles/{*ID}.
idIntegerYY N ID of the conneciton profile.
nameStringYY N Name of the connection profile.

modeled-instance-activate-now.deviceUnits

List of modeled device which contains details like device-name, platform, os-version, serial-number

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this deviceUnits node in the current node context. This link can be used to retrieve or operate on the currently referenced deviceUnits in the tree path.
devicemodeled-instance-activate-now.deviceUnits.deployDeviceUnit[]NY Y * Modeled device which contains details like device-name, platform, os-version, serial-number.

modeled-instance-activate-now.deviceUnits.deployDeviceUnit

Modeled device which contains details like device-name, platform, os-version, serial-number

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)YY N NNLink to this deployDeviceUnit node in the current node context. This link can be used to retrieve or operate on the currently referenced deployDeviceUnit in the tree path.
device-nameStringNY Y NNName of the device.
platformStringNY Y NNPlatform of the device.
os-versionStringNY Y NNOS version of the device.
serial-numberStringNY Y NNSerial Number of device.
static-ipStringNY Y NNStatic IP address with prefix(subnet mask). Static IP is mandatory if the connection profile of type is 'static' and optional for other cases.
For example 192.168.27.24/24.
gatewayStringNY Y NNGateway for static IP.

modeled-instance-activate-now.snmpSettingREST

Parameters for SNMP settings like SNMP V1/V2C/V3

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this snmpSettingREST node in the current node context. This link can be used to retrieve or operate on the currently referenced snmpSettingREST in the tree path.
snmp-v1-settingmodeled-instance-activate-now.snmpSettingREST.snmpV1SettingRESTNY Y SNMPV1 parameters used for polling.
snmp-v2c-settingmodeled-instance-activate-now.snmpSettingREST.snmpV2CSettingRESTNY Y SNMPV2C parameters used for polling.
snmp-v3-settingmodeled-instance-activate-now.snmpSettingREST.snmpV3SettingRESTNY Y SNMPV3 parameters used for polling.

modeled-instance-activate-now.snmpSettingREST.snmpV1SettingREST

SNMPV1 parameters used for polling

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this snmpV1SettingREST node in the current node context. This link can be used to retrieve or operate on the currently referenced snmpV1SettingREST in the tree path.
community-nameStringNY Y Community name for SNMP V1.

Default: "public".

modeled-instance-activate-now.snmpSettingREST.snmpV2CSettingREST

SNMPV2C parameters used for polling

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this snmpV2CSettingREST node in the current node context. This link can be used to retrieve or operate on the currently referenced snmpV2CSettingREST in the tree path.
community-nameStringNY Y Community name for SNMP V2C.

Default: "public".

modeled-instance-activate-now.snmpSettingREST.snmpV3SettingREST

SNMPV3 parameters used for polling

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this snmpV3SettingREST node in the current node context. This link can be used to retrieve or operate on the currently referenced snmpV3SettingREST in the tree path.
user-nameStringNY Y * SNMP V3 user name.
authentication-typeenum(authentication-type)NY 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:
MD5 
SHA1 
NONENone

Default: MD5.
authentication-passwordStringNY Y SNMP V3 User's authentication password
The password should contain minimum of 8 characters and maximum 1024 characters.
privacy-typeenum(privacy-type)NY Y SNMP V3 Privacy protocol
If the privacy-type is NONE then the field privacy-password is not applicable.

Possible Values:
AES128 
AES192 
AES256 
DES 
NONENone

Default: DES.
privacy-passwordStringNY Y SNMP V3 User's privacy password
The password should contain minimum of 8 characters and maximum 1024 characters.

modeled-instances (vnd.net.juniper.space.device-management.modeled-device-management.modeled-instances;version=1)

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this modeled-instances node in the current node context. This link can be used to retrieve or operate on the currently referenced modeled-instances in the tree path.
@totalIntegerYY N Total number of modeled-instances in the API result set. If paging parameters are used in the query to limit the result set size, then total represents the total number of modeled-instances in all the pages of the result set.
modeled-instancemodeled-instances.deployInstance[]NY Y * List of modeled device with device-family and its associated connection type.

modeled-instances.deployInstance

List of modeled device with device-family and its associated connection type

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@hrefString(URI)NY Y * NNLink to an external deployInstance. Here, href points to the deployInstance in the primary deployInstance collection.

Hyperlink Template: /api/space/device-management/modeled-device-management/modeled-instances/{*ID}.
@uriString(URI)YY N NNLink to this deployInstance node in the current node context. This link can be used to retrieve or operate on the currently referenced deployInstance in the tree path.

Hyperlink Template: /api/space/device-management/modeled-device-management/modeled-instances/{*ID}.
idIntegerYY N NNId of the modeled instance.
nameStringYY N YYName of the modeled instance.
descriptionStringYY N NNDescription of the modeled instance.
device-familyStringYY N NNDevice 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-typeenum(connection-profile-type)YY N NNConnection profile to be associated.

Possible Values:
Static 
DHCP 
PPPoA 
PPPoE 
NONENone
.
device-countIntegerYY N YYNumber of devices, This will be overridden if deviceUnits are explicitly defined.

modify-device-target-ip (vnd.net.juniper.space.device-management.modify-device-target-ip;version=1)

Field NameTypeRead OnlyGETPUT / POSTDescription
new-ip-addressStringNY Y * The new IP of the device.

multilayer-subnetwork (vnd.net.juniper.space.managed-domain.multilayer-subnetwork;version=1)

The 'multilayer-subnetwork' resource model represents information about a single sublayer network. It consists of the following fields:

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)NY Y Link to this multilayer-subnetwork node in the current node context. This link can be used to retrieve or operate on the currently referenced multilayer-subnetwork in the tree path.
managed-elementmanaged-element[]NY Y The managed elements associated with the subnetwork.
tcpJSTerminationPoint[]NY Y A collection of multilayer subnetworks
topological-linkJSTopologicalLink[]NY Y A collection of topological links.

multilayer-subnetworks (vnd.net.juniper.space.managed-domain.multilayer-subnetworks;version=1)

The 'multilayer-subnetworks' resource model contains information about accessible sublayer networks for a managed element. The 'multilayer-subnetworks' type in in the 'multilayer-subnetworks' resource represent pull-through data. The multilayer-subnetwork type is a complex type and consists of the following fields:

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)NY Y Link to this multilayer-subnetworks node in the current node context. This link can be used to retrieve or operate on the currently referenced multilayer-subnetworks in the tree path.
@sizeIntegerNY Y The size of the collection.
multilayer-subnetworkmultilayer-subnetworks.multiLayerSubnetwork[]NY Y This resource model represents the topology provided by the Junos OS. The main services provided by an MLSN are the set-up and tear-down of subnetwork connections. The managed element may belong to more than one MLSN at different layer rates (for example, SDH and ATM). However, MLSNs cannot overlap at the same layer rate.

multilayer-subnetworks.multiLayerSubnetwork

The 'multiLayerSubnetwork' type contains information about a single sublayer network and a link to the resource for a managed element along with the pull-through fields

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@keyIntegerNY Y * NNThe ID of the subnetwork
@uriString(URI)NY Y NNLink to this multiLayerSubnetwork node in the current node context. This link can be used to retrieve or operate on the currently referenced multiLayerSubnetwork in the tree path.
idIntegerNY Y * NNThe ID of the managed element
nameStringNY Y NNThe name of the subnetwork.

multipart (multipart/form-data)

This class represents a POJO which contains two fields one is for device image byte stream and other one is for device image name This class will be used to hold multipart data during uploads

Field NameTypeRead OnlyGETPUT / POSTDescription
imageFileDatabyte[]NY Y Byte stream for the device image file
imageFileNameStringNY Y Name of the device image file

package (vnd.net.juniper.space.software-management.package;version=1)

The 'package' resource model represents details about the software package. It consists of the following fields:

Field NameTypeRead OnlyGETPUT / POSTDescription
@keyIntegerNY Y A unique identifier for the software package
@uriString(URI)NY Y Link to this package node in the current node context. This link can be used to retrieve or operate on the currently referenced package in the tree path.
fileNameStringNY Y Name of the software package
typeStringNY Y Type of the software package
fileMD5StringNY Y MD5 checksum of the software package
versionStringNY Y Version of the software package.
sizeLongNY Y Size of software package in bytes.
decodeStatusenum(decodeStatus)NY Y File decode status of the software package from base64 encoded form.

Possible Values:
DECODE_SUCCESS 
DECODE_FAILED 
uploadStatusenum(uploadStatus)NY Y Package file upload status.

Possible Values:
UPLOAD_SUCCESS 
UPLOAD_FAILED 
allowDeleteBooleanNY Y Whether or not to allow the deletion of the software package.
uploadTimeStringNY Y The starting time when the software package was uploaded to the system.
supportedPlatformspackage.supportedPlatformsNY Y All the device platforms on which the software package can be installed.
supportedSeriespackage.supportedSeriesNY Y All the device series on which the software package can be deployed.
deviceSeriesenum(deviceSeries)NY Y * The type of platform for the software package.

Possible Values:
MorMXorTM or MX or T
EX3200 
EX4200 
EX8200 
SRXSME 
SRX1k3k 
SRX5000 
J 
EX2200 
EX4500EX4500 or EX4550
QFX 
EX6200 
EX3300 
EX3242EX3200 or EX4200
LN 
TRAPEZE_MX 
TRAPEZE_WLC 
MX_MID_RANGEMX Mid Range/ACX Series
MOBILITY_MX 
OLIVE 
MQF 
EX4550 
VSRX 
XRE200EX-XRE200 or EX8200
EX9200 
EX4300 
SRXVRE 
VRR 
VMX 
JAM_MXMX240 or MX480 or MX960 or MX2010 or MX2020
MorMXorTorPTXM or MX or T or PTX
ACX5KACX 5K series
EX4600 
EX2300_EX3400EX3400 or EX2300 or EX2300-C
SRXMRSRX4100 or SRX4200
SRXENTEDGESRX1500
VM_HOST_PTXPTX1000 or PTX3000 or PTX5000 or PTX10008 or JNP10008
VM_HOSTMX or PTX
methodStringNY Y Supported operations for software management provided by Junos Space.
methodStringNY 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.
methodStringNY 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.
methodStringNY 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.
methodStringNY 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-devicesStringNY 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.

package.deviceImageUploadStatus


package.deviceImageDecodeStatus


package.supportedPlatforms

The 'supportedPlatforms' field of the 'supportedPlatforms' type represents the platforms supported for the software package.

Field NameTypeRead OnlyGETPUT / POSTDescription
platformString[]NY Y A collection of platforms. Each object in the collection represents a platform supported by the software package.

package.supportedSeries

The 'supportedSeries' field of the 'supportedSeries' type represents the series supported by the device.

Field NameTypeRead OnlyGETPUT / POSTDescription
seriesString[]NY Y A collection of series. Each object in the collection represents a series supported by the software package.

packages (vnd.net.juniper.space.software-management.packages;version=1)

The 'packages' resource model represents a user's view of all the software packages (device images) present in the system. The package field of type 'deviceImage' represent the pull-through data. It consists of the following fields:

Field NameTypeRead OnlyGETPUT / POSTDescription
@sizeIntegerNY Y Total number of uploaded software packages (device images).
@uriString(URI)NY Y Link to this packages node in the current node context. This link can be used to retrieve or operate on the currently referenced packages in the tree path.
packagepackages.deviceImageMO[]NY Y * A collection of software packages. Each software package represents details about it.

packages.deviceImageMO

The 'package' field of type 'deviceImage' consists of the following pull-through fields:

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)NY Y NNLink to this deviceImageMO node in the current node context. This link can be used to retrieve or operate on the currently referenced deviceImageMO in the tree path.
@hrefString(URI)NY Y * NNLink to an external deviceImageMO. Here, href points to the deviceImageMO in the primary deviceImageMO collection.
@keyStringNY Y NN Unique identifier for the software package.
fileNameStringNY Y * NN Name of the software package
typeStringNY Y * NN Type of the software package
versionStringNY Y * NN Version of the software package.
platformTypeenum(platformType)NY Y * NN The platform of the device.

Possible Values:
MorMXorTM or MX or T
EX3200 
EX4200 
EX8200 
SRXSME 
SRX1k3k 
SRX5000 
J 
EX2200 
EX4500EX4500 or EX4550
QFX 
EX6200 
EX3300 
EX3242EX3200 or EX4200
LN 
TRAPEZE_MX 
TRAPEZE_WLC 
MX_MID_RANGEMX Mid Range/ACX Series
MOBILITY_MX 
OLIVE 
MQF 
EX4550 
VSRX 
XRE200EX-XRE200 or EX8200
EX9200 
EX4300 
SRXVRE 
VRR 
VMX 
JAM_MXMX240 or MX480 or MX960 or MX2010 or MX2020
MorMXorTorPTXM or MX or T or PTX
ACX5KACX 5K series
EX4600 
EX2300_EX3400EX3400 or EX2300 or EX2300-C
SRXMRSRX4100 or SRX4200
SRXENTEDGESRX1500
VM_HOST_PTXPTX1000 or PTX3000 or PTX5000 or PTX10008 or JNP10008
VM_HOSTMX or PTX

password (vnd.net.juniper.space.user-management.password;version=3)

Field NameTypeRead OnlyGETPUT / POSTDescription
valueStringNY Y * The password of the user.

password (vnd.net.juniper.space.application-management.platform.settings.password;version=1)

The 'password' resource model represents password settings on Junos Space. It consists of the following fields:

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)NY Y Link to this password node in the current node context. This link can be used to retrieve or operate on the currently referenced password in the tree path.
Minimum-number-of-charactersIntegerNY Y The minimum number of characters allowed in the password.
Number-of-previous-passwords-cannot-be-reusedIntegerNY Y Number of previous passwords that cannot be reused.
Number-of-unsuccessful-login-attemptsIntegerNY Y Number of successful login attempts.
Time-interval-for-lockout-in-hoursIntegerNY Y Time interval for lockout of account in hours.
Time-interval-for-password-expiry-in-monthsIntegerNY Y Time interval for password expiry in months.
Time-interval-for-password-expiry-notification-in-monthsIntegerNY Y Time interval for password expiry.
At-least-one-lowercase-characterStringNY Y Password should contain at least one lowercase character.
At-least-one-uppercase-characterStringNY Y Password should contain at least one uppercase character.
At-least-one-number-not-in-the-last-positionStringNY Y Password should contain at least one number that is not in the last position.
At-least-one-special-character-not-in-the-last-positionStringNY Y Password should contain at least one special character that is not in the last position.
Not-repeat-of-the-user-IDStringNY Y Password should not be the same as the user ID.
Not-reverse-of-the-user-IDStringNY Y Password should not be the reverse of the user ID.
No-more-than-three-repetitive-charactersStringNY Y Password should not contain more than three repetitive characters.

platform (vnd.net.juniper.space.application-management.platform;version=1)

The 'platform' resource model represents details of Junos Space and consists of following fields:

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)NY Y Link to this platform node in the current node context. This link can be used to retrieve or operate on the currently referenced platform in the tree path.
titleStringNY Y * Title representing the Junos Space
versionStringNY Y * Version of Junos Space
subVersionStringNY Y * Sub-version of Junos Space
descriptionStringNY Y * Description of Junos Space
settingsStringNY Y * Location of 'settings' resource.
featuresStringNY Y * Location of 'features' resource.

preview-cli-configlet-request (vnd.net.juniper.space.configuration-management.preview-cli-configlet-request;version=3)

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this preview-cli-configlet-request node in the current node context. This link can be used to retrieve or operate on the currently referenced preview-cli-configlet-request in the tree path.
contextStringNY Y Context.
cli-configlet-paramspreview-cli-configlet-request.cliConfigletParamsNY Y All the parameters of the Configlet.
devicepreview-cli-configlet-request.deviceNY Y * The device to which the configlet needs to be applied.

preview-cli-configlet-request.cliConfigletParams

All the parameters of the Configlet

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this cliConfigletParams node in the current node context. This link can be used to retrieve or operate on the currently referenced cliConfigletParams in the tree path.
cli-configlet-parampreview-cli-configlet-request.cliConfigletParams.configletParamForNBI[]NY Y * The configlet parameter and value.

preview-cli-configlet-request.cliConfigletParams.configletParamForNBI

The configlet parameter and value

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)YY N NNLink to this configletParamForNBI node in the current node context. This link can be used to retrieve or operate on the currently referenced configletParamForNBI in the tree path.
parameterpreview-cli-configlet-request.cliConfigletParams.configletParamForNBI.paramForNBINY Y NNThe parameter in the Configlet.
param-valueStringNY Y * NNParameter Value.

preview-cli-configlet-request.cliConfigletParams.configletParamForNBI.paramForNBI

The parameter in the Configlet

Field NameTypeRead OnlyGETPUT / POSTDescription
@hrefString(URI)NY Y * Link to an external paramForNBI. Here, href points to the paramForNBI in the primary paramForNBI collection.

Hyperlink Template: /api/space/configuration-management/cli-configlets/{*ID}/cli-configlet-params/{*ID}.
param-idIntegerYY N Configlet parameter ID.
nameStringYY N Parameter Name.
configlet-idIntegerYY N Configlet ID.

preview-cli-configlet-request.device

The device to which the configlet needs to be applied.

Field NameTypeRead OnlyGETPUT / POSTDescription
@hrefString(URI)NY Y * Link to an external device. Here, href points to the device in the primary device collection.

Hyperlink Template: /api/space/device-management/devices/{*ID}.
idIntegerYY N Device ID.
nameStringYY N Device Name.

preview-cli-configlet-response (vnd.net.juniper.space.configuration-management.preview-cli-configlet-response;version=3)

CLI Configlet Preview

Field NameTypeRead OnlyGETPUT / POSTDescription
valueStringNY Y * Value.

profile (vnd.net.juniper.space.user-management.profile;version=1)

The 'remote-profile' resource model represents a remote profile for a user registered on a remote authentication server. It consists of the following fields.

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)NY Y Link to this profile node in the current node context. This link can be used to retrieve or operate on the currently referenced profile in the tree path.
@read-onlyBooleanNY Y A flag that indicates whether the remote profile is read-only.
idIntegerNY Y The HREF ID of the remote profile.
nameStringNY Y * The remote profile name.
descriptionStringNY Y The remote profile description.
viewAllObjectsBooleanNY Y User can view all jobs or user's own jobs in job manager
roleTypeenum(roleType)NY Y The RBAC role access type for the remote profile.

Possible Values:
GUI_ROLE_ACCESSGUI Role Access
API_ROLE_ACCESSAPI Role Access
ALL_ACCESSGUI Access and API Access
api-access-profileprofile.apiAccessProfileNY Y REST API access restriction rule for user.
rolesprofile.remoteProfileRolesNY Y * The roles associated with the remote profile.
domainsprofile.domainsNY Y  

profile.remoteProfileRoles

The 'roles' field consists of the following pull-through fields:

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)NY Y Link to this remoteProfileRoles node in the current node context. This link can be used to retrieve or operate on the currently referenced remoteProfileRoles in the tree path.
roleprofile.remoteProfileRoles.remoteProfileRole[]NY Y * The collection of objects of type 'userrole'. Each object represents a role associated with a user.

profile.remoteProfileRoles.remoteProfileRole

The 'userroles' field of type 'userrole' consists of the following pull-through fields:

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@hrefString(URI)NY Y * NNLink to an external remoteProfileRole. Here, href points to the remoteProfileRole in the primary remoteProfileRole collection.
@uriString(URI)NY Y NNLink to this remoteProfileRole node in the current node context. This link can be used to retrieve or operate on the currently referenced remoteProfileRole in the tree path.
idIntegerNY Y NN A identifier for the user role.
nameStringNY Y NN The name of the role.
titleStringNY Y * NN The location of a role.

profile.apiAccessProfile

Field NameTypeRead OnlyGETPUT / POSTDescription
@hrefString(URI)YY N Link to an external apiAccessProfile. Here, href points to the apiAccessProfile in the primary apiAccessProfile collection.

Hyperlink Template: /api/space/user-management/api-access-profiles/{*ID}.
idIntegerYY N Id of the api access profile.
nameStringNY Y * Name of the api access profile.
descriptionStringNY Y * Description for the api access profile.
exec-rpc-rulesprofile.apiAccessProfile.rpcRulesNY Y  

profile.apiAccessProfile.rpcRules

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this rpcRules node in the current node context. This link can be used to retrieve or operate on the currently referenced rpcRules in the tree path.
exec-rpc-ruleprofile.apiAccessProfile.rpcRules.aPIRPCRule[]NY Y *  

profile.apiAccessProfile.rpcRules.aPIRPCRule

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)YY N NNLink to this aPIRPCRule node in the current node context. This link can be used to retrieve or operate on the currently referenced aPIRPCRule in the tree path.
ruleStringNY Y * NNRPC restriction rule.

profile.domains

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this domains node in the current node context. This link can be used to retrieve or operate on the currently referenced domains in the tree path.

Hyperlink Template: /api/space/user-management/remote-profiles/{*ID}/domains.
domainprofile.domains.domain[]NY Y *  

profile.domains.domain

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)YY N NNLink to this domain node in the current node context. This link can be used to retrieve or operate on the currently referenced domain in the tree path.

Hyperlink Template: /api/space/domain-management/domains/{*ID}.
@hrefString(URI)NY Y * NNLink to an external domain. Here, href points to the domain in the primary domain collection.

Hyperlink Template: /api/space/domain-management/domains/{*ID}.
idIntegerYY N NNDomain ID.
nameStringYY N YYDomain Name.

profile-ref (vnd.net.juniper.space.domain-management.profile-ref;version=2)

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this profile-ref node in the current node context. This link can be used to retrieve or operate on the currently referenced profile-ref in the tree path.

Hyperlink Template: /api/space/domain-management/domains/{*ID}/profiles/{*ID}.
@hrefString(URI)NY Y * Link to an external profile-ref. Here, href points to the profile-ref in the primary profile-ref collection.

Hyperlink Template: /api/space/user-management/profiles/{*ID}.
role-typeenum(role-type)NY Y *

Possible Values:
GUI_ROLE_ACCESSGUI Role Access
API_ROLE_ACCESSAPI Role Access
ALL_ACCESSGUI Access and API Access

Default: ALL_ACCESS.
domainsprofile-ref.domainsNY Y *  
idIntegerYY N  
nameStringNY Y  

profile-ref.domains

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this domains node in the current node context. This link can be used to retrieve or operate on the currently referenced domains in the tree path.

Hyperlink Template: /api/space/domain-management/domains/{*ID}/profiles/{*ID}/domains.
domainprofile-ref.domains.domain[]NY Y *  

profile-ref.domains.domain

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)YY N NNLink to this domain node in the current node context. This link can be used to retrieve or operate on the currently referenced domain in the tree path.

Hyperlink Template: /api/space/domain-management/domains/{*ID}/profiles/{*ID}/domains/{*ID}.
@hrefString(URI)NY Y * NNLink to an external domain. Here, href points to the domain in the primary domains collection.

Hyperlink Template: /api/space/domain-management/domains/{*ID}.
idIntegerYY N NN 
nameStringNY Y NN 

profiles (vnd.net.juniper.space.user-management.profiles;version=1)

The 'remote-profiles' resource model represents remote profiles for all users registered on a remote authentication server. It consists of the following fields:

Field NameTypeRead OnlyGETPUT / POSTPATCHDescription
@uriString(URI)NY Y * NLink to this profiles node in the current node context. This link can be used to retrieve or operate on the currently referenced profiles in the tree path.
@sizeIntegerNY Y * N A link to identify the 'profiles' resource.
profileprofiles.remoteProfile[]NY Y * YA single remote profile.

profiles.remoteProfile

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
keyIntegerNY Y NN A unique identifier for the user.
nameStringNY Y YY The name of the user.
descriptionStringNY Y YY A description of the user.
uriStringNY Y NN A link to identify the 'user' resource.
viewAllObjectsbooleanNY Y NN User can view all jobs or user's own jobs in job manager
read-onlyBooleanNY Y YYA flag that indicates whether the remote profile is read-only.
hrefStringNY Y NN The location of the 'user' resource.
roleTypeenum(roleType)NY Y NNThe role type, which is 'RemoteProfileRoleAccess'.

Possible Values:
GUI_ROLE_ACCESSGUI Role Access
API_ROLE_ACCESSAPI Role Access
ALL_ACCESSGUI Access and API Access

Profiles_patch (vnd.net.juniper.space.user-management.profiles_patch;version=1)

ptp (vnd.net.juniper.space.managed-domain.ptp;version=1)

The 'ptp' resource model contains information about a single PTP, including connection termination points (CTPs). It consists of the following fields:

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)NY Y Link to this ptp node in the current node context. This link can be used to retrieve or operate on the currently referenced ptp in the tree path.
ctpJSConnectionTerminationPoint[]NY Y The collection of connection termination points for this PTP.
typeStringNY Y The type of information
encapsulationStringNY Y The encapsulation of the PTP.
taggingStringNY Y Not supported
adminStatusStringNY Y The administration status
operationStatusStringNY Y The operation status of the termination point
linkLevelTypeStringNY Y The encapsulation being used on the physical interface.
linkTypeStringNY Y The type of link to the physical interface: full-duplex or half-duplex
speedIntegerNY Y The speed on the PTP
speedStrStringNY Y A string representation of the speed on the CTP
mtuIntegerNY Y The maximum transmission unit (MTU) size on the physical interface
mtuStrStringNY Y A string representation of the MTU on the CTP
hardwarePhysicalAddressStringNY Y The physical address of the hardware
lacpBundleStringNY Y The aggregated Ethernet interface to which this PTP belongs
managed-elementptp.managedElementObjNY Y * Managed element parent for this PTP.

ptp.managedElementObj

The 'managedElementObj' type contains information about a managed element

Field NameTypeRead OnlyGETPUT / POSTDescription
@hrefString(URI)NY Y Link to an external managedElementObj. Here, href points to the managedElementObj in the primary managedElementObj collection.
idIntegerNY Y * The ID of the managed element.
ipAddrStringNY Y The IP address of the managed element.

ptp (vnd.net.juniper.space.managed-domain.ptp;version=1)

The 'ptps' resource model contains information about a single PTP, including connection termination points. It consists of the following fields:

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)NY Y Link to this ptp node in the current node context. This link can be used to retrieve or operate on the currently referenced ptp in the tree path.
ctpJSConnectionTerminationPoint[]NY Y The collection of connection termination points for this PTP.
typeStringNY Y The 'information' type
encapsulationStringNY Y The encapsulation on the PTP.
taggingStringNY Y Not supported
adminStatusStringNY Y The administration status.
operationStatusStringNY Y The operation status of the termination point
linkLevelTypeStringNY Y The encapsulation being used on the physical interface
linkTypeStringNY Y The type of of link to the physical interface: full-duplex or half-duplex
speedIntegerNY Y The speed on the PTP.
speedStrStringNY Y A string representation of speed on the CTP
mtuIntegerNY Y The maximum transmission unit (MTU) size on the physical interface.
mtuStrStringNY Y A string representation of the MTU on the CTP
hardwarePhysicalAddressStringNY Y The physical address of the hardware
lacpBundleStringNY Y The aggregated Ethernet interface to which this PTP belongs
managed-elementptp.managedElementObjNY Y * The information about a managed object.
customized-attributesview-manage-labelsNY Y * The managed labels for this PTP.

ptp.managedElementObj

The 'me' type contains information about a managed element

Field NameTypeRead OnlyGETPUT / POSTDescription
@hrefString(URI)NY Y Link to an external managedElementObj. Here, href points to the managedElementObj in the primary managedElementObj collection.
idIntegerNY Y * The ID of the managed element.
ipAddrStringNY Y IP address of the managed element.

ptp-ref (vnd.net.juniper.space.managed-domain.ptp-ref;version=1)

The 'ptp-ref' resource model contains information about a single PTP. This resource model consists of the following fields:

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)NY Y NNLink to this ptp-ref node in the current node context. This link can be used to retrieve or operate on the currently referenced ptp-ref in the tree path.
@hrefString(URI)NY Y NNLink to an external ptp-ref. Here, href points to the ptp-ref in the primary ptp-ref collection.
typeStringNY Y NN The type of information
encapsulationStringNY Y NN The encapsulation of the PTP
taggingStringNY Y NN Not supported
adminStatusStringNY Y NN The administration status
operationStatusStringNY Y NN The operation status of the termination point
linkLevelTypeStringNY Y NN The encapsulation being used on the physical interface
linkTypeStringNY Y NN The type of link to the physical interface : full-duplex or half-duplex.
speedIntegerNY Y NN The speed at the PTP
speedStrStringNY Y NN String representation of the speed on the CTP
mtuIntegerNY Y NN Maximum transmission unit (MTU) size on the physical interface
mtuStrStringNY Y NN A string representation of the MTU on the CTP
hardwarePhysicalAddressStringNY Y NN The physical address of the hardware
lacpBundleStringNY Y NN The aggregated Ethernet interface to which this PTP belongs
managed-elementptp-ref.managedElementDTONY Y * NNManaged element parent for this PTP.

ptp-ref.managedElementDTO

The 'managedElementDTO' type contains information about a managed element.

Field NameTypeRead OnlyGETPUT / POSTDescription
@hrefString(URI)NY Y Link to an external managedElementDTO. Here, href points to the managedElementDTO in the primary managedElementDTO collection.
idIntegerNY Y * The ID of the managed element
ipAddrStringNY Y The IP address of the managed element

ptps (vnd.net.juniper.space.managed-domain.ptps;version=1)

The 'ptps' resource model contains information about and links to all PTPs in the Space. It consists of the following fields:

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)NY Y Link to this ptps node in the current node context. This link can be used to retrieve or operate on the currently referenced ptps in the tree path.
@sizeIntegerNY Y Size of the collection.
ptpptps.physicalTerminationPoint[]NY Y Collection of physical termination points (PTPs).

ptps.physicalTerminationPoint

The 'ptps' type contains information about a single PTP and pull-through fields

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)NY Y NNLink to this physicalTerminationPoint node in the current node context. This link can be used to retrieve or operate on the currently referenced physicalTerminationPoint in the tree path.
@hrefString(URI)NY Y NNLink to an external physicalTerminationPoint. Here, href points to the physicalTerminationPoint in the primary physicalTerminationPoint collection.
@keyIntegerNY Y * NNID of the PTP
nameStringNY Y NNName of the PTP
typeStringNY Y NNType of information.
encapsulationStringNY Y NNEncapsulation of the PTP.
taggingStringNY Y NN Not supported
adminStatusStringNY Y NNAdministration status of the PTP
operationStatusStringNY Y NNOperational status of the termination point
speedIntegerNY Y NNSpeed on the termination point
mtuIntegerNY Y NNMaximum transmission unit (MTU) size on the physical interface
lacpBundleStringNY Y NNAggregated Ethernet interface to which this PTP belongs
deviceIdStringNY Y NNID of the device on which the PTP exists

ptps (vnd.net.juniper.space.managed-domain.ptps;version=4)

Collection of Physical Interfaces of the Device(s)

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this ptps node in the current node context. This link can be used to retrieve or operate on the currently referenced ptps in the tree path.
@totalIntegerYY N Total number of ptps in the API result set. If paging parameters are used in the query to limit the result set size, then total represents the total number of ptps in all the pages of the result set.
ptpptps.deviceInterfaceStatus[]NY Y * Collection of Physical Interfaces of the Device(s).

ptps.deviceInterfaceStatus

Collection of Physical Interfaces of the Device(s)

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)YY N NNLink to this deviceInterfaceStatus node in the current node context. This link can be used to retrieve or operate on the currently referenced deviceInterfaceStatus in the tree path.

Hyperlink Template: /api/space/managed-domain/ptps/{*ID}.
@hrefString(URI)YY N NNLink to an external deviceInterfaceStatus. Here, href points to the deviceInterfaceStatus in the primary ptps collection.

Hyperlink Template: /api/space/managed-domain/ptps/{*ID}.
mtuIntegerYY N YYMtu of the Physical Interface.
ipv4-addressStringYY N YYIPv4 address of the Physical Interface.
hardware-physical-addressStringYY N YYHardware Physical Address.
speed-stringStringYY N YYSpeed of the Physical Interface in string format.
speedIntegerYY N YYSpeed of the Physical Interface.
ipv6-addressStringYY N YYIPv6 address of the Physical Interface.
admin-statusStringYY N YYAdmin Status of the Physical Interface.
operation-statusStringYY N YYOperation Status of the Physical Interface.
ipv6-addressesStringYY N YYIPv6 addresses of the Device.
link-typeStringYY N YYLink Type of the Physical Interface.
interface-indexIntegerYY N YYInterface Index of the Physical Interface.

Default: 0.
domain-nameStringYY N YYName of the Domain to which the Device belongs to.
idIntegerYY N YYUnique ID of the Physical Interface.
link-level-typeStringYY N YYLink Level Type of the Physical Interface.
device-nameStringYY N YYName of the Device.
descriptionStringYY N YYDescription of the Physical Interface.
domain-idIntegerYY N YYUnique ID of the Physical Interface.
nameStringYY N YYName of the Physical Interface.
mtu-stringStringYY N YYMtu of the Physical Interface in string format.
device-idIntegerYY N YYUnique ID of the Device.
ipv4-addressesStringNY Y YYIPv4 addresses of the Device.

ptps-ref (vnd.net.juniper.space.managed-domain.ptps-ref;version=1)

The 'ptps-ref' resource model contains information about physical termination points (PTPs) inside a managed element. The 'ptps' field in 'ptps-ref'represents pull-through data. It is a complex type and consists of the following fields:

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)NY Y Link to this ptps-ref node in the current node context. This link can be used to retrieve or operate on the currently referenced ptps-ref in the tree path.
@sizeIntegerNY Y The size of the collection
ptpptps-ref.physicalTerminationPoint[]NY Y A collection of physical termination points

ptps-ref.physicalTerminationPoint

The 'ptps-ref' type contains information about a single PTP and the pull-through fields.

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@hrefString(URI)NY Y NNLink to an external physicalTerminationPoint. Here, href points to the physicalTerminationPoint in the primary physicalTerminationPoint collection.
@uriString(URI)NY Y NNLink to this physicalTerminationPoint node in the current node context. This link can be used to retrieve or operate on the currently referenced physicalTerminationPoint in the tree path.
@keyIntegerNY Y * NNThe ID of the PTP
nameStringNY Y NN The name of the PTP
typeStringNY Y NNThe type of information
encapsulationStringNY Y NNThe encapsulation of the PTP
taggingStringNY Y NN Not supported
adminStatusStringNY Y NN The administration status of the PTP
operationStatusStringNY Y NNThe operational status of the termination point
speedIntegerNY Y NNThe speed of the termination point.
mtuIntegerNY Y NN The maximum transmission unit (MTU) size on the physical interface
lacpBundleStringNY Y NN The aggregated Ethernet interface to which this PTP belongs
deviceIdStringNY Y NNThe ID of the device on which the PTP exist
idIntegerNY Y * NN The ID of the managed element

push-configuration-request (vnd.net.juniper.space.configuration-management.push-configuration-request;version=5)

Field NameTypeRead OnlyGETPUT / POSTDescription
configuration-to-pushpush-configuration-request.configurationToPushsNY Y *  
space-based-device-lockBooleanNY Y * Space Based Device Lock.

Default: true.

push-configuration-request.configurationToPushs

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this configurationToPushs node in the current node context. This link can be used to retrieve or operate on the currently referenced configurationToPushs in the tree path.
device-config-mappingpush-configuration-request.configurationToPushs.deviceConfigMapping[]NY Y *  

push-configuration-request.configurationToPushs.deviceConfigMapping

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)YY N NNLink to this deviceConfigMapping node in the current node context. This link can be used to retrieve or operate on the currently referenced deviceConfigMapping in the tree path.
configspush-configuration-request.configurationToPushs.deviceConfigMapping.configsNY Y * NN 
device-idIntegerNY Y * NNDevice ID.

push-configuration-request.configurationToPushs.deviceConfigMapping.configs

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this configs node in the current node context. This link can be used to retrieve or operate on the currently referenced configs in the tree path.
@totalIntegerYY N Total number of gen_push-configuration-request-configuration-to-pushs-configuration-to-pushs-configs in the API result set. If paging parameters are used in the query to limit the result set size, then total represents the total number of gen_push-configuration-request-configuration-to-pushs-configuration-to-pushs-configs in all the pages of the result set.
configString[]NY Y * Configs.

raw-cli-configuration (vnd.net.juniper.space.device-management.raw-cli-configuration;version=5)

configuration details

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this raw-cli-configuration node in the current node context. This link can be used to retrieve or operate on the currently referenced raw-cli-configuration in the tree path.
*idIntegerYY N DeviceConfiguration ID.
configurationStringYY N Configuration.

raw-cli-configuration-request (vnd.net.juniper.space.device-management.raw-cli-configuration-request;version=5)

Xpath list request

Field NameTypeRead OnlyGETPUT / POSTDescription
xpath-listraw-cli-configuration-request.xpathListsNY Y xpath list.

raw-cli-configuration-request.xpathLists

xpath list

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this xpathLists node in the current node context. This link can be used to retrieve or operate on the currently referenced xpathLists in the tree path.
xpathString[]NY Y * Xpath for which the configuration will be fetched.

raw-configuration (vnd.net.juniper.space.device-management.raw-configuration;version=1)

The 'raw-configuration' resource model represents access to raw configuration content of a device without expanding configuration groups. It can be further defined by the following fields:

Field NameTypeRead OnlyGETPUT / POSTDescription
configurationStringNY Y * The configuration string.
idIntegerNY Y A unique identifier for the raw configuration.
methodStringNY Y This represents a link to a POST method that is used to match the content of the configuration.

raw-configuration (vnd.net.juniper.space.device-management.raw-configuration;version=3)

The 'raw-configuration' resource model represents access to raw configuration content of a device without expanding configuration groups. It can be further defined by the following fields:

Field NameTypeRead OnlyGETPUT / POSTDescription
configurationStringNY Y * The configuration string.
idIntegerNY Y Unique identifier for the raw configuration.
methodStringNY Y This represent a link to a POST method that is used to match the content of the configuration.

raw-xml-configuration (vnd.net.juniper.space.device-management.raw-xml-configuration;version=5)

configuration details

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this raw-xml-configuration node in the current node context. This link can be used to retrieve or operate on the currently referenced raw-xml-configuration in the tree path.
*idIntegerYY N DeviceConfiguration ID.
configurationStringYY N Configuration.

raw-xml-configuration-request (vnd.net.juniper.space.device-management.raw-xml-configuration-request;version=5)

Xpath list request

Field NameTypeRead OnlyGETPUT / POSTDescription
xpath-listraw-xml-configuration-request.xpathListsNY Y Xpath list.

raw-xml-configuration-request.xpathLists

Xpath list

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this xpathLists node in the current node context. This link can be used to retrieve or operate on the currently referenced xpathLists in the tree path.
xpathString[]NY Y * Xpath for which the configuration will be fetched.

reassign-jobs-request (vnd.net.juniper.space.job-management.reassign-jobs-request;version=3)

Field NameTypeRead OnlyGETPUT / POSTDescription
jobsreassign-jobs-request.instanceManagedObjectsNY Y *  

reassign-jobs-request.instanceManagedObjects

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this instanceManagedObjects node in the current node context. This link can be used to retrieve or operate on the currently referenced instanceManagedObjects in the tree path.
jobreassign-jobs-request.instanceManagedObjects.monitorableTaskInstanceManagedObject[]NY Y *  

reassign-jobs-request.instanceManagedObjects.monitorableTaskInstanceManagedObject

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@hrefString(URI)NY Y * NNLink to an external monitorableTaskInstanceManagedObject. Here, href points to the monitorableTaskInstanceManagedObject in the primary monitorableTaskInstanceManagedObject collection.

Hyperlink Template: /api/space/job-management/jobs/{*ID}.
idIntegerYY N YYThe ID of the job.
nameStringYY N NNMonitorableTaskInstanceManagedObject Name.

reboot-devices-job-results (vnd.net.juniper.space.device-management.job-instances.reboot-devices-job-results;version=3)

Reboot Devices Job Results on which the given Reboot Device is triggered

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this reboot-devices-job-results node in the current node context. This link can be used to retrieve or operate on the currently referenced reboot-devices-job-results in the tree path.
@totalIntegerYY N Total number of reboot-devices-job-results in the API result set. If paging parameters are used in the query to limit the result set size, then total represents the total number of reboot-devices-job-results in all the pages of the result set.
reboot-device-job-resultreboot-devices-job-results.rebootDeviceResult[]NY Y * Reboot Device Job Result Entry.

reboot-devices-job-results.rebootDeviceResult

Reboot Device Job Result Entry

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)YY N NNLink to this rebootDeviceResult node in the current node context. This link can be used to retrieve or operate on the currently referenced rebootDeviceResult in the tree path.
reboot-device-statusenum(reboot-device-status)NY Y * YYReboot device status.

Possible Values:
FAILEDFailed
SUCCESSSuccess
.
idIntegerYY N NNJob result table row ID.
devicereboot-devices-job-results.rebootDeviceResult.deviceNY Y * NN 
hostnameStringNY Y YYHostname.
reboot-fail-reasonStringNY Y * YNIf device Reboot failed, set the fail reason.
device-idIntegerNY Y * YYdevice id.
ipStringNY Y YNip address.

reboot-devices-job-results.rebootDeviceResult.device

Field NameTypeRead OnlyGETPUT / POSTDescription
@hrefString(URI)NY Y * Link to an external device. Here, href points to the device in the primary device collection.

Hyperlink Template: /api/space/managed-domain/devices-require-polling/{*ID}.
idIntegerYY N Device ID.
nameStringYY N Device Name.

reboot-devices-request (vnd.net.juniper.space.device-management.reboot-devices-request;version=3)

Execute Reboot Devices

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this reboot-devices-request node in the current node context. This link can be used to retrieve or operate on the currently referenced reboot-devices-request in the tree path.
messageStringNY Y * Power Off Message.
power-offBooleanNY Y * Power Off.

Default: false.
lsys-label-toggleBooleanNY Y * Lsys Label Toggle.
devicesreboot-devices-request.devicesNY Y * Devices to be rebooted.

reboot-devices-request.devices

Devices to be rebooted

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this devices node in the current node context. This link can be used to retrieve or operate on the currently referenced devices in the tree path.

Hyperlink Template: /devices.
devicereboot-devices-request.devices.device[]NY Y * Device to be Rebooted.

reboot-devices-request.devices.device

Device to be Rebooted

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@hrefString(URI)NY Y * NNLink to an external device. Here, href points to the device in the primary device collection.

Hyperlink Template: /api/space/device-management/devices/{*ID}.
idIntegerYY N YYDevice ID.
nameStringYY N YYDevice Name.

resolve-key-conflict-request (vnd.net.juniper.space.device-management.resolve-key-conflict-request;version=3)

Request to resolve the Key Conflict for the given Devices

Field NameTypeRead OnlyGETPUT / POSTDescription
devicesresolve-key-conflict-request.credentialsBeansNY Y * Collection of Devices for which the Key Conflict to be resolved.

resolve-key-conflict-request.credentialsBeans

Collection of Devices for which the Key Conflict to be resolved

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this credentialsBeans node in the current node context. This link can be used to retrieve or operate on the currently referenced credentialsBeans in the tree path.
deviceresolve-key-conflict-request.credentialsBeans.deviceCredentialsBean[]NY Y * Device for which the Key Conflict to be resolved.

resolve-key-conflict-request.credentialsBeans.deviceCredentialsBean

Device for which the Key Conflict to be resolved

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)YY N NNLink to this deviceCredentialsBean node in the current node context. This link can be used to retrieve or operate on the currently referenced deviceCredentialsBean in the tree path.
ip-addressStringNY Y * NNIP Address of the Device for which the Key Conflict to be resolved.
user-nameStringNY Y * NNDevice User for which the Key Conflict to be resolved.
passwordStringNY Y * NNPassword of the Device for which the Key Conflict to be resolved.

resync-devices-job-results (vnd.net.juniper.space.device-management.job-instances.resync-devices-job-results;version=3)

Collection of Resync Devices Job result on which the given Resync Job is triggered

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this resync-devices-job-results node in the current node context. This link can be used to retrieve or operate on the currently referenced resync-devices-job-results in the tree path.
@totalIntegerYY N Total number of resync-devices-job-results in the API result set. If paging parameters are used in the query to limit the result set size, then total represents the total number of resync-devices-job-results in all the pages of the result set.
resync-device-job-resultresync-devices-job-results.resyncDeviceResult[]NY Y * Resync Device Job Result Entry.

resync-devices-job-results.resyncDeviceResult

Resync Device Job Result Entry

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)YY N NNLink to this resyncDeviceResult node in the current node context. This link can be used to retrieve or operate on the currently referenced resyncDeviceResult in the tree path.
idIntegerYY N NNJob result table row ID.
job-idIntegerNY Y * NNJob ID.
resync-typeenum(resync-type)NY Y NNResync Type.

Possible Values:
AUTORESYNCAuto-resync
MANNUALMannual
.
resync-fail-reasonStringNY Y * YNIf device resync failed, set the fail reason.
deviceresync-devices-job-results.resyncDeviceResult.deviceNY Y * NNDevice Object.
hostnameStringNY Y YYHostname.
device-idIntegerNY Y * YYdevice id.
resync-device-statusenum(resync-device-status)NY Y * YYResync device status.

Possible Values:
FAILEDFailed
SUCCESSSuccess
CANCELLEDCancelled
.
ipStringNY Y YNip address.

resync-devices-job-results.resyncDeviceResult.device

Device Object

Field NameTypeRead OnlyGETPUT / POSTDescription
@hrefString(URI)NY Y * Link to an external device. Here, href points to the device in the primary device collection.

Hyperlink Template: /api/space/managed-domain/devices-require-polling/{*ID}.
idIntegerYY N Device ID.
nameStringYY N Device Name.

resync-devices-request (vnd.net.juniper.space.device-management.resync-devices-request;version=3)

Execute Resync Devices

Field NameTypeRead OnlyGETPUT / POSTDescription
devicesresync-devices-request.deviceListsNY Y * Devices to be Resynchronized.

resync-devices-request.deviceLists

Devices to be Resynchronized

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this deviceLists node in the current node context. This link can be used to retrieve or operate on the currently referenced deviceLists in the tree path.
deviceresync-devices-request.deviceLists.device[]NY Y * Device to be Deleted.

resync-devices-request.deviceLists.device

Device to be Deleted

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@hrefString(URI)NY Y * NNLink to an external device. Here, href points to the device in the primary device collection.

Hyperlink Template: /api/space/device-management/devices/{*ID}.
idIntegerYY N YYDevice ID.
nameStringYY N YYDevice Name.

retry-deploy-configuration-request (vnd.net.juniper.space.configuration-management.retry-deploy-configuration-request;version=4)

Field NameTypeRead OnlyGETPUT / POSTDescription
devicesretry-deploy-configuration-request.devicesNY Y * Collection of device objects.

retry-deploy-configuration-request.devices

Collection of device objects

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this devices node in the current node context. This link can be used to retrieve or operate on the currently referenced devices in the tree path.
deviceretry-deploy-configuration-request.devices.device[]NY Y *  

retry-deploy-configuration-request.devices.device

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@hrefString(URI)NY Y * NNLink to an external device. Here, href points to the device in the primary device collection.

Hyperlink Template: /api/space/device-management/devices/{*ID}.
idIntegerYY N YYDevice ID.
nameStringYY N YYDevice Name.

role (vnd.net.juniper.space.user-management.role;version=3)

Field NameTypeRead OnlyGETPUT / POSTPATCHDescription
@uriString(URI)YY N NLink to this role node in the current node context. For primary collection members, href and uri are always the same.

Hyperlink Template: /api/space/user-management/roles/{*ID}.
@hrefString(URI)YY N NLink to an external role. Here, href points to the role in the primary roles collection.

Hyperlink Template: /api/space/user-management/roles/{*ID}.
idIntegerYY N NRole ID.
nameStringYY N NRole Name.
titleStringNY Y * YRole Title.
descriptionStringNY Y YRole Description.
predefinedBooleanYY N NIs this a predefined role? If false, then it's a custom role.

Default: false.
sharableBooleanYY N NSharable.
less-tasksStringNY Y YLess Tasks.
capabilitiesrole.capsNY Y * YCapabilities.
tasksStringYY N NTasks associated with this role

Hyperlink Template: /api/space/user-management/roles/{*ID}/tasks.

role.caps

Capabilities

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this caps node in the current node context. This link can be used to retrieve or operate on the currently referenced caps in the tree path.

Hyperlink Template: /api/space/user-management/roles/{*ID}/capabilities.
capabilityrole.caps.capability[]NY Y * Single capability for a role.

role.caps.capability

Single capability for a role

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)YY N NNLink to this capability node in the current node context. This link can be used to retrieve or operate on the currently referenced capability in the tree path.

Hyperlink Template: /api/space/user-management/roles/{*ID}/capabilities/{*ID}.
@hrefString(URI)NY Y * NNLink to an external capability. Here, href points to the capability in the primary capability collection.

Hyperlink Template: /api/space/user-management/capabilities/{*ID}.
idIntegerYY N NNCapability ID.
nameStringYY N NNCapability Name.
titleStringYY N NNCapability Title.

Role_patch (vnd.net.juniper.space.user-management.role_patch;version=3)

role-ref (vnd.net.juniper.space.user-management.role-ref;version=1)

The 'role-ref' resource model represents details about a role associated with a user. It consists of the following fields:

Field NameTypeRead OnlyGETPUT / POSTDescription
@keyIntegerNY Y * A unique identifier for the role.
@hrefString(URI)NY Y * Link to an external role-ref. Here, href points to the role-ref in the primary role-ref collection.
@uriString(URI)NY Y * Link to this role-ref node in the current node context. This link can be used to retrieve or operate on the currently referenced role-ref in the tree path.
nameStringNY Y * The name of the role.
titleStringNY Y The title of the role.

role-ref (vnd.net.juniper.space.user-management.role-ref;version=1)

The profiles resource model represents remote profiles for all users registered on a remote authentication server.

Field NameTypeRead OnlyGETPUT / POSTDescription
@keyIntegerNY Y * The unique identifier for the role.
@hrefString(URI)NY Y * Link to an external role-ref. Here, href points to the role-ref in the primary role-ref collection.
@uriString(URI)NY Y * Link to this role-ref node in the current node context. This link can be used to retrieve or operate on the currently referenced role-ref in the tree path.
nameStringNY Y * The name of the role.
titleStringNY Y The title of the role.

roles (vnd.net.juniper.space.user-management.roles;version=3)

Field NameTypeRead OnlyGETPUT / POSTPATCHDescription
@uriString(URI)YY N NLink to this roles node in the current node context. This link can be used to retrieve or operate on the currently referenced roles in the tree path.
@totalIntegerYY N NTotal number of roles in the API result set. If paging parameters are used in the query to limit the result set size, then total represents the total number of roles in all the pages of the result set.
roleroles.role[]NY Y * YA single role.

roles.role

A single role

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)YY N NNLink to this role node in the current node context. This link can be used to retrieve or operate on the currently referenced role in the tree path.

Hyperlink Template: /api/space/user-management/roles/{*ID}.
@hrefString(URI)YY N NNLink to an external role. Here, href points to the role in the primary roles collection.

Hyperlink Template: /api/space/user-management/roles/{*ID}.
idIntegerYY N YYRole ID.
descriptionStringNY Y YYRole Description.
nameStringNY Y NNRole Name.
titleStringNY Y YYRole Title.
predefinedBooleanYY N YYIs this a predefined role? If false, then it's a custom role.

Default: false.
less-tasksStringNY Y NNLess Tasks.

Roles_patch (vnd.net.juniper.space.user-management.roles_patch;version=3)

roles-ref (vnd.net.juniper.space.user-management.roles-ref;version=1)

The profiles resource model represents remote profiles for all users registered on a remote authentication server.

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)NY Y Link to this roles-ref node in the current node context. This link can be used to retrieve or operate on the currently referenced roles-ref in the tree path.
@sizeIntegerNY Y The total number of roles associated with a user.
roleroles-ref.roleRef[]NY Y * The collection of objects of type 'userRole'. Each object represents a role associated with the user.

roles-ref.roleRef

The 'role' field of type 'userRole' consists of the following pull-through fields:

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@keyIntegerNY Y NN A unique identifier for the role.
@hrefString(URI)NY Y NNLink to an external roleRef. Here, href points to the roleRef in the primary roleRef collection.
@uriString(URI)NY Y NNLink to this roleRef node in the current node context. This link can be used to retrieve or operate on the currently referenced roleRef in the tree path.
idIntegerNY Y NN The role ID.
nameStringNY Y NN The name of the role.

roles-ref (vnd.net.juniper.space.user-management.roles-ref;version=1)

The 'roles-ref' resource model represents all the roles associated with a user. The 'role' field in 'roles' represents pull-through data. It consists of the following fields:

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)NY Y Link to this roles-ref node in the current node context. This link can be used to retrieve or operate on the currently referenced roles-ref in the tree path.
@sizeIntegerNY Y The total number of roles associated with a user.
roleroles-ref.userRole[]NY Y * The collection of objects of type 'userRole'. Each object represents a role associated with the user.

roles-ref.userRole

The 'role' field of type 'userRole' consists of the following pull-through fields:

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@keyIntegerNY Y NN A unique identifier for the role.
@hrefString(URI)NY Y NNLink to an external userRole. Here, href points to the userRole in the primary userRole collection.
@uriString(URI)NY Y NNLink to this userRole node in the current node context. This link can be used to retrieve or operate on the currently referenced userRole in the tree path.
idIntegerNY Y NN The role ID
nameStringNY Y NN The name of the role.

routing-engine (vnd.net.juniper.space.managed-domain.routing-engine;version=1)

The 'routing-engine' resource model contains information about a single piece of equipment. It consists of the following fields:

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)NY Y NNLink to this routing-engine node in the current node context. This link can be used to retrieve or operate on the currently referenced routing-engine in the tree path.
ptpptp-ref[]NY Y NNA collection of PTPs in this equipment
supportingEquipmentrouting-engine[]NY Y NNAll supported equipment for this equipment
nameStringNY Y NNThe name of the equipment
expectedEquipmentObjectTypeStringNY Y NN The type of the expected equipment. This attribute might not have a value if there is no expected equipment.
installedEquipmentObjectTypeStringNY Y NNThe type of installed equipment. This attribute might not have a value if there is no installed equipment.
installedModelStringNY Y NN The model of the installed equipment. This attribute might not have a value if there is no installed equipment.
installedPartNumberStringNY Y NNThe vendor's part number for the installed equipment
installedSerialNumberStringNY Y NN The vendor's serial number for the installed equipment. The combination of the installed part number and the installed serial number for a specific piece of vendor equipment must uniquely identify the equipment.
manufacturerStringNY Y NNThe name of the equipment vendor
installedVersionStringNY Y NN The vendor's version identifier for the installed equipment

routing-engines (vnd.net.juniper.space.managed-domain.routing-engines;version=1)

The 'routing-engines' resource model contains information about the collection of equipment for a managed element. It is a complex type and consists of the following fields:

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)NY Y Link to this routing-engines node in the current node context. This link can be used to retrieve or operate on the currently referenced routing-engines in the tree path.
@sizeIntegerNY Y Size of the collection
equipmentrouting-engines.equipment[]NY Y Represents the collection of equipment for a managed element.

routing-engines.equipment

The 'equipment' type contains information of a single equipment and pull-through fields.

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@keyStringNY Y * NN Serial number of the equipment
@uriString(URI)NY Y NNLink to this equipment node in the current node context. This link can be used to retrieve or operate on the currently referenced equipment in the tree path.
idIntegerNY Y * NN ID of the managed element
nameStringNY Y NN Name of the equipment
expectedEquipmentObjectTypeStringNY Y NN An attribute that identifies the type of the expected resource
installedEquipmentObjectTypeStringNY Y NN An attribute that identifies the type of the installed resource
installedModelStringNY Y NN An attribute that identifies the type of the installed resource
installedPartNumberStringNY Y NN An attribute that identifies the resource part number (PN) of the installed equipment.
installedVendorPartNumberStringNY Y NN An attribute that identifies the resource vendor part number (VPN) of the installed equipment.
installedVendorMaterialNumberStringNY Y NN An attribute that identifies the resource vendor material number (VMN) of the installed equipment.
installedVersionStringNY Y NNAn attribute that identifies the resource version of the installed equipment.
installedDescriptionStringNY Y NNDescription of the installation
manufacturerStringNY Y NNName of equipment manufacturer

routing-instances (vnd.net.juniper.space.managed-domain.routing-instances;version=1)

The routing-instances' resource model contains information about a single equipment holder. It is a complex type and consists of following fields:

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)NY Y Link to this routing-instances node in the current node context. This link can be used to retrieve or operate on the currently referenced routing-instances in the tree path.
@sizeIntegerNY Y The size of the collection
routing-instancerouting-instances.routingInstance[]NY Y A collection of all routing instances for a managed element.

routing-instances.routingInstance

The 'routingInstance' type contains information about a single equipment holder and the pull-through fields

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
routeDistinguisherStringNY Y NNA unique route distinguisher that is associated with this routing instance.
vlanTagsInnerStringNY Y NNThe inner VLAN tag
vlanTagsOuterStringNY Y NNThe outer VLAN tag
vrfTargetImportStringNY Y NN The community name of the import target for the VPN routing and forwarding instance
vrfTargetExportStringNY Y NN The community name of the export target for the VPN routing and forwarding instance
idIntegerNY Y * NNThe ID of the route.
nameStringNY Y NNThe name of the route

routing-options (vnd.net.juniper.space.managed-domain.routing-options;version=1)

The 'routing-options' resource model contains information about a single equipment holder.

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)NY Y Link to this routing-options node in the current node context. This link can be used to retrieve or operate on the currently referenced routing-options in the tree path.
idIntegerNY Y * The ID of the resource.
nameStringNY Y The name of the resource.
autonomousSystemlongNY Y The autonomous system ID.

rpc (vnd.net.juniper.space.device-management.rpc;version=1)

The 'rpc' resource model contains the following fields:

Field NameTypeRead OnlyGETPUT / POSTDescription
statusStringNY Y The status of the executed RPC command
dataStringNY Y The data of the executed RPC command
descriptionStringNY Y Description of the executed RPC command
devIdIntegerNY Y The devId of the executed RPC command
channelIdIntegerNY Y The channel ID of the executed RPC command
rpcCommandsRpcCommandsNY Y * Complex type of the RPC command
commitCommentStringNY Y The commit comment of the executed RPC command
netConfRepliesNetConfRepliesNY Y The netconf replies for the executed command
configurationStringNY Y The configuration of executed RPC command
deviceFamilyStringNY Y The device family
isClusterBooleanNY Y Cluster mode
enableDiscardChangesBooleanNY Y Enable discard changes for netconf
netconfConfirmedCommitBooleanNY Y Netconf confirmed commit

rpc (vnd.net.juniper.space.device-management.rpc;version=3)

The 'rpc' resource model contains the following fields:

Field NameTypeRead OnlyGETPUT / POSTDescription
statusStringNY Y The status of the executed RPC command
dataStringNY Y The data of the executed RPC command
descriptionStringNY Y The description of the executed RPC command
devIdIntegerNY Y The devId of the executed RPC command
channelIdIntegerNY Y The channel ID of the executed RPC command
rpcCommandsRpcCommandsNY Y * Complex type of the RPC command
commitCommentStringNY Y The commit comment of the executed RPC command
netConfRepliesNetConfRepliesNY Y The netconf replies for the executed command
configurationStringNY Y The configuration of the executed RPC command
deviceFamilyStringNY Y The device family
isClusterBooleanNY Y Cluster mode
enableDiscardChangesBooleanNY Y Enable discard changes for netconf
netconfConfirmedCommitBooleanNY Y Netconf confirmed commit

rsa-key-transfer-job-results (vnd.net.juniper.space.device-management.job-instances.rsa-key-transfer-job-results;version=3)

Collection of RSA key transfer Job Results

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this rsa-key-transfer-job-results node in the current node context. This link can be used to retrieve or operate on the currently referenced rsa-key-transfer-job-results in the tree path.
@totalIntegerYY N Total number of rsa-key-transfer-job-results in the API result set. If paging parameters are used in the query to limit the result set size, then total represents the total number of rsa-key-transfer-job-results in all the pages of the result set.
rsa-key-transfer-job-resultrsa-key-transfer-job-results.rSAKeyTransferJobResult[]NY Y * RSA key Transfer Job Result.

rsa-key-transfer-job-results.rSAKeyTransferJobResult

RSA key Transfer Job Result

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)YY N NNLink to this rSAKeyTransferJobResult node in the current node context. This link can be used to retrieve or operate on the currently referenced rSAKeyTransferJobResult in the tree path.
idIntegerYY N NNJob result table row ID.
space-user-nameStringNY Y * YYSpace User Name.
statusStringNY Y * YNStatus.
descriptionStringNY Y * YNDescription.
host-nameStringNY Y YYHost Name.
device-addressStringNY Y * YNDevice Address.
job-instance-idIntegerNY Y * YNJob Instance ID.

schedule-purging-job-request (vnd.net.juniper.space.fabric-management.schedule-purging-job-request;version=1)

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this schedule-purging-job-request node in the current node context. This link can be used to retrieve or operate on the currently referenced schedule-purging-job-request in the tree path.
category-idsschedule-purging-job-request.categoryIdsNY Y *  
ipaddressStringNY Y * Ipaddress.

schedule-purging-job-request.categoryIds

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this categoryIds node in the current node context. This link can be used to retrieve or operate on the currently referenced categoryIds in the tree path.
category-idString[]NY Y * Category Ids.

schemas (vnd.net.juniper.space.schema-service.schemas;version=1)

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this schemas node in the current node context. This link can be used to retrieve or operate on the currently referenced schemas in the tree path.
@totalIntegerYY N Total number of schemas in the API result set. If paging parameters are used in the query to limit the result set size, then total represents the total number of schemas in all the pages of the result set.
schemaschemas.schema[]NY Y *  

schemas.schema

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)YY N NNLink to this schema node in the current node context. This link can be used to retrieve or operate on the currently referenced schema in the tree path.

Hyperlink Template: /api/space/schema-serviceupload-tgz-schema-file.
device-familyStringNY Y * NNDevice Family.
schema-locationStringNY Y * NNSchema Location.
releaseStringNY Y * NNRelease.

script (vnd.net.juniper.space.script-management.script;version=1)

The 'script' resource model represents a script available in the system. It consists of the following fields:

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)NY Y Link to this script node in the current node context. This link can be used to retrieve or operate on the currently referenced script in the tree path.
idStringNY Y A unique identifier for the script
scriptNameStringNY Y The name of the script.
categoryStringNY Y Category of the script. It would be a arbitrary value used for sorting/filtering
domain-nameStringNY Y  
domain-idIntegerNY Y  
typeenum(type)NY Y The type of the script

Possible Values:
TYPE_COMMITCommit Script
TYPE_OPOp Script
TYPE_EVENTEvent Script
TYPE_UNKNOWNUnknown Script
formatenum(format)NY Y The format of the script

Possible Values:
FORMAT_SLAXSLAX
FORMAT_XSLXSL
lastestRevisionStringNY Y The version of the script.
commentsStringNY Y A description of the script.
scriptSizeLongNY Y The size of script in bytes.
completionStatusenum(completionStatus)NY Y The import status of the script

Possible Values:
IMPORT_SUCCESS 
IMPORT_FAILED 
UPDATE_SUCCESS 
UPDATE_FAILED 
destFileNameStringNY Y The destination file name for the script
revisionsAvailableStringNY Y The revisions available for the script.
scriptContentsStringNY Y The contents of the script.
domainStringYY N  
collectionStringNY Y The location of the different resources
contentsStringNY Y The location of the 'contents' resource
parametersStringNY Y The location of the 'parameters' resource
view-associated-devicesStringNY Y The association of the script to the devices.

script.scriptStatus

script-mgmt-job-results (vnd.net.juniper.space.script-management.script-mgmt-job-results;version=1)

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this script-mgmt-job-results node in the current node context. This link can be used to retrieve or operate on the currently referenced script-mgmt-job-results in the tree path.
@totalIntegerYY N Total number of script-mgmt-job-results in the API result set. If paging parameters are used in the query to limit the result set size, then total represents the total number of script-mgmt-job-results in all the pages of the result set.
script-mgmt-job-resultscript-mgmt-job-results.scriptMgmtJobResult[]NY Y *  

script-mgmt-job-results.scriptMgmtJobResult

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)YY N NNLink to this scriptMgmtJobResult node in the current node context. This link can be used to retrieve or operate on the currently referenced scriptMgmtJobResult in the tree path.
idIntegerYY N NNJob result table row ID.
script-paramsStringYY N NN 
action-urlStringYY N NN 
job-statusStringYY N NN 
enable-auto-upgradeBooleanYY N NN 
job-idIntegerYY N NN 
script-idIntegerYY N YY 
rule-dataStringYY N NN 
contextStringYY N NN 
job-remarksStringYY N YY 
sequenceIntegerYY N NN 
script-versionStringYY N YY 
rule-typeStringYY N NN 
ipStringYY N YY 
action-typeenum(action-type)YY N NN

Possible Values:
Transfer_ScriptTransfer Scripts to Devices
Enable_ScriptEnable Scripts on Devices
Disable_ScriptDisable Scripts on Devices
Remove_ScriptRemove Scripts from Devices
Deploy_ScriptStage Scripts on Devices
Verify_ScriptVerify Scripts on Devices
Execute_ScriptExecute Script on Devices
Deploy_Script_BundleStage Script Bundle on Devices
Execute_Script_BundleExecute Script Bundle on Devices
Enable_Script_BundleEnable Script Bundle on Devices
Disable_Script_BundleDisable Script Bundle on Devices
.
hostnameStringYY N YY 
script-enableBooleanYY N NN 

Default: true.
script-typeenum(script-type)YY N YY

Possible Values:
TYPE_COMMITCommit Script
TYPE_OPOp Script
TYPE_EVENTEvent Script
TYPE_UNKNOWNUnknown Script
.
script-mgmt-job-statusenum(script-mgmt-job-status)YY N YY

Possible Values:
FAILEDFailed
SUCCESSSuccess
INPROGRESSInprogress
NOTSTARTEDScheduled
NOOPERATIONNo-Operation
.
script-nameStringYY N YY 
categoryStringYY N YY Category Category is an arbitrary value used for sorting/filtering.
device-idIntegerYY N NN 
associated-tag-listStringYY N NN 
local-script-responseStringYY N NN 
on-close-stringStringYY N NN 
script-bundle-idIntegerYY N NN 
device-nameStringYY N YY 
script-statusStringYY N NN 
deviceStringYY N NNDevice Link.
jobStringYY N NN 
scriptStringYY N NNScript Link.

scripts (vnd.net.juniper.space.script-management.scripts;version=3)

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this scripts node in the current node context. This link can be used to retrieve or operate on the currently referenced scripts in the tree path.
@totalIntegerYY N Total number of scripts in the API result set. If paging parameters are used in the query to limit the result set size, then total represents the total number of scripts in all the pages of the result set.
scriptscripts.script[]NY Y *  

scripts.script

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)YY N NNLink to this script node in the current node context. This link can be used to retrieve or operate on the currently referenced script in the tree path.

Hyperlink Template: /api/space/script-management/scripts/{*ID}.
@hrefString(URI)YY N NNLink to an external script. Here, href points to the script in the primary scripts collection.

Hyperlink Template: /api/space/script-management/scripts/{*ID}.
idIntegerYY N YYScript ID.
scriptNameStringNY Y * YYScript Name.
categoryStringNY Y YYCategory.
domain-nameStringNY Y NNDomain Name.
domain-idIntegerNY Y NYDomain ID.

settings (vnd.net.juniper.space.application-management.platform.settings;version=1)

The 'settings' resource model represents different setting options available for Junos Space and consists of following fields:

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)NY Y Link to this settings node in the current node context. This link can be used to retrieve or operate on the currently referenced settings in the tree path.
userStringNY Y * Location of 'user' resource corresponding to user settings on Junos Space.
deviceStringNY Y * Location of 'device' resource corresponding to device settings on Junos Space.
passwordStringNY Y * Location of 'password' resource corresponding to password settings on Junos Space.
audit-logStringNY Y * Location of 'audit-log' resource corresponding to audit-log settings on Junos Space.
domainStringNY Y * Location of 'domain' resource corresponding to domain settings on Junos Space.
authmodeStringNY Y * Location of 'authmode' resource corresponding to user->authmode settings on Junos Space.
cli-configletStringNY Y * Cli-Configlet enable/disable Approval Workflow

smtp-server (vnd.net.juniper.space.smtp-management.smtp-server;version=1)

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this smtp-server node in the current node context. For primary collection members, href and uri are always the same.

Hyperlink Template: /api/space/smtp-management/smtp-servers/{*ID}.
@hrefString(URI)YY N Link to an external smtp-server. Here, href points to the smtp-server in the primary smtp-servers collection.

Hyperlink Template: /api/space/smtp-management/smtp-servers/{*ID}.
*idIntegerYY N SmtpServer ID.
nameStringNY Y * SmtpServer Name.
ip-addressStringNY Y * IP Address.
portIntegerNY Y * Port.

Default: 587.
use-tlsBooleanNY Y * Use TLS.

Default: false.
security-settingStringNY Y * Security Setting.
auth-passwordStringNY Y * Auth Password.
host-addressStringNY Y * Host Address.
from-email-addrStringNY Y * From Email Addr.
domain-nameStringYY N Domain Name.
is-activeStringNY Y * Is Active.

Default: "Yes".
use-sslBooleanNY Y * Use SSL.

Default: false.
auth-userStringNY Y * Auth User.
domain-idIntegerNY Y Domain ID.
user-authBooleanNY Y * User Auth.

Default: false.
active-serverBooleanNY Y * Active Server.

smtp-servers (vnd.net.juniper.space.smtp-management.smtp-servers;version=1)

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this smtp-servers node in the current node context. This link can be used to retrieve or operate on the currently referenced smtp-servers in the tree path.
@totalIntegerYY N Total number of smtp-servers in the API result set. If paging parameters are used in the query to limit the result set size, then total represents the total number of smtp-servers in all the pages of the result set.
smtp-serversmtp-servers.smtpServer[]NY Y *  

smtp-servers.smtpServer

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)YY N NNLink to this smtpServer node in the current node context. This link can be used to retrieve or operate on the currently referenced smtpServer in the tree path.

Hyperlink Template: /api/space/smtp-management/smtp-servers/{*ID}.
@hrefString(URI)YY N NNLink to an external smtp-server. Here, href points to the smtp-server in the primary smtp-servers collection.

Hyperlink Template: /api/space/smtp-management/smtp-servers/{*ID}.
idIntegerYY N NNSmtpServer ID.
nameStringNY Y * YYSmtpServer Name.
ip-addressStringNY Y * NNIP Address.
portIntegerNY Y * NYPort.

Default: 587.
is-activeStringNY Y * NYIs Active.

Default: "Yes".

software-identities (vnd.net.juniper.space.managed-domain.software-identities;version=1)

The 'software-identities'resource model contains information about softwares available on the managed element. It is a complex type and consists of the following fields:

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)NY Y Link to this software-identities node in the current node context. This link can be used to retrieve or operate on the currently referenced software-identities in the tree path.
@sizeIntegerNY Y The size of the collection
software-identitysoftware-identities.softwareIdentity[]NY Y A collection of software identities

software-identities.softwareIdentity

The 'softwareIdentity' type contains information about a single piece of software and the pull-through fields

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@keyIntegerNY Y * NNID of the software
nameStringNY Y NNThe name of the software.
majorVersionIntegerNY Y NNThe major version information
minorVersionIntegerNY Y NNThe minor version information
revisionNumberDoubleNY Y NNThe software revision number, if any
buildNumberIntegerNY Y NNThe build number of the software.
deviceFamilyStringNY Y NNThe device family associated with this software package
softwareReleaseVersionStringNY Y NNThe device family to which the software belongs
ClassificationStringNY Y NNClassification information

stop-syslog-events (vnd.net.juniper.space.device-management.stop-syslog-events;version=3)

Field NameTypeRead OnlyGETPUT / POSTDescription
taskidIntegerNY Y * Enter the task ID.

stop-syslog-events-response (vnd.net.juniper.space.device-management.stop-syslog-events-response;version=3)

Field NameTypeRead OnlyGETPUT / POSTDescription
valueBooleanNY Y * Output value.

submit-cli-configlet-request (vnd.net.juniper.space.configuration-management.submit-cli-configlet-request;version=3)

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this submit-cli-configlet-request node in the current node context. This link can be used to retrieve or operate on the currently referenced submit-cli-configlet-request in the tree path.
contextStringNY Y Context.
cli-configlet-paramssubmit-cli-configlet-request.cliConfigletParamsNY Y  
devicessubmit-cli-configlet-request.deviceNY Y *  

submit-cli-configlet-request.cliConfigletParams

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this cliConfigletParams node in the current node context. This link can be used to retrieve or operate on the currently referenced cliConfigletParams in the tree path.

Hyperlink Template: /cli-configlet-params.
cli-configlet-paramsubmit-cli-configlet-request.cliConfigletParams.configletParamForNBI[]NY Y *  

submit-cli-configlet-request.cliConfigletParams.configletParamForNBI

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)YY N NNLink to this configletParamForNBI node in the current node context. This link can be used to retrieve or operate on the currently referenced configletParamForNBI in the tree path.
parametersubmit-cli-configlet-request.cliConfigletParams.configletParamForNBI.paramForNBIYY N NN 
parameter-valueStringYY N NNParameter Value.

submit-cli-configlet-request.cliConfigletParams.configletParamForNBI.paramForNBI

Field NameTypeRead OnlyGETPUT / POSTDescription
@hrefString(URI)NY Y * Link to an external paramForNBI. Here, href points to the paramForNBI in the primary paramForNBI collection.

Hyperlink Template: /api/space/configuration-management/cli-configlets/{*ID}/cli-configlet-params/{*ID}.
param-idIntegerYY N Configlet parameter ID.
nameStringYY N Parameter Name.
configlet-idIntegerYY N Configlet ID.

submit-cli-configlet-request.device

Field NameTypeRead OnlyGETPUT / POSTDescription
@hrefString(URI)NY Y * Link to an external device. Here, href points to the device in the primary device collection.

Hyperlink Template: /api/space/device-management/devices/{*ID}.
idIntegerYY N Device ID.
nameStringYY N Device Name.

submit-cli-configlet-request (vnd.net.juniper.space.device-management.submit-cli-configlet-request;version=5)

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this submit-cli-configlet-request node in the current node context. This link can be used to retrieve or operate on the currently referenced submit-cli-configlet-request in the tree path.
configletsubmit-cli-configlet-request.cliConfigurationTemplateNY Y *  
contextStringNY Y * Context.
cli-configlet-paramssubmit-cli-configlet-request.cliConfigletParamsNY Y  

submit-cli-configlet-request.cliConfigurationTemplate

Field NameTypeRead OnlyGETPUT / POSTDescription
@hrefString(URI)NY Y * Link to an external cliConfigurationTemplate. Here, href points to the cliConfigurationTemplate in the primary cliConfigurationTemplate collection.

Hyperlink Template: /api/space/configuration-management/cli-templates/{*ID}.
idIntegerYY N Configlet ID
Unique key of the configlet. Through this id, configlet details could be accessed/modified.
nameStringYY N Configlet Name
The name of the configlet and it cannot exceed 255 characters. Allowable characters include dash (-), underscore (_), letters, and numbers and period (.).
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(.) characters..

submit-cli-configlet-request.cliConfigletParams

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this cliConfigletParams node in the current node context. This link can be used to retrieve or operate on the currently referenced cliConfigletParams in the tree path.

Hyperlink Template: /cli-configlet-params.
cli-configlet-paramsubmit-cli-configlet-request.cliConfigletParams.configletParamForNBI[]NY Y *  

submit-cli-configlet-request.cliConfigletParams.configletParamForNBI

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)YY N NNLink to this configletParamForNBI node in the current node context. This link can be used to retrieve or operate on the currently referenced configletParamForNBI in the tree path.
parametersubmit-cli-configlet-request.cliConfigletParams.configletParamForNBI.paramForNBINY Y NN 
parameter-valueStringNY Y NNParameter Value.

submit-cli-configlet-request.cliConfigletParams.configletParamForNBI.paramForNBI

Field NameTypeRead OnlyGETPUT / POSTDescription
@hrefString(URI)NY Y * Link to an external paramForNBI. Here, href points to the paramForNBI in the primary paramForNBI collection.

Hyperlink Template: /api/space/configuration-management/cli-configlets/{*ID}/cli-configlet-params/{*ID}.
param-idIntegerYY N Configlet parameter ID.
nameStringYY N Parameter Name.
configlet-idIntegerYY N Configlet ID.

submit-cli-configlet-response (vnd.net.juniper.space.configuration-management.submit-cli-configlet-response;version=3)

Field NameTypeRead OnlyGETPUT / POSTDescription
valueIntegerNY Y * Value.

submit-cli-configlet-response (vnd.net.juniper.space.device-management.submit-cli-configlet-response;version=5)

Field NameTypeRead OnlyGETPUT / POSTDescription
valueIntegerNY Y * Value.

svn-request (vnd.net.juniper.space.hardware-catalog.svn-request;version=1)

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this svn-request node in the current node context. This link can be used to retrieve or operate on the currently referenced svn-request in the tree path.
svn-trunk-urlStringNY Y * Svn Trunk Url.
svn-user-nameStringNY Y * Svn User Name.
svn-user-passwordStringNY Y * Svn User Password.

svn-response (vnd.net.juniper.space.hardware-catalog.svn-response;version=1)

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this svn-response node in the current node context. This link can be used to retrieve or operate on the currently referenced svn-response in the tree path.
svn-trunk-urlStringNY Y * Svn Trunk Url.
svn-user-nameStringNY Y * Svn User Name.
svn-user-passwordStringNY Y * Svn User Password.

tag (vnd.net.juniper.space.tag-management.tag;version=1)

The 'tag' resource contains information for a tag object and all tagged objects contained by this tag. When using this object for renaming or sharing the tag, one name or type field between them is mandatory.

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)NY Y Link to this tag node in the current node context. This link can be used to retrieve or operate on the currently referenced tag in the tree path.
idIntegerNY Y The ID of the tag object.
nameStringNY Y * The name of the tag object.
typeStringNY Y * The access type of the tag object. It can be private or public.
targetstag.targetsNY Y The access collection of targets tagged by a tag.

tag.targets

This contains a particular tag and its information.

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)NY Y Link to this targets node in the current node context. This link can be used to retrieve or operate on the currently referenced targets in the tree path.
@hrefString(URI)NY Y Link to an external targets. Here, href points to the targets in the primary targets collection.
targettag.targets.target[]NY Y The collection of targets tagged by a tag.

tag.targets.target

This contains a particular tag and its information.

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@typeStringNY Y NN The media type that can be used to access the target using an HREF attribute.
@uriString(URI)NY Y NNLink to this target node in the current node context. This link can be used to retrieve or operate on the currently referenced target in the tree path.
@hrefString(URI)NY Y * NNLink to an external target. Here, href points to the target in the primary target collection.
idIntegerNY Y NNThe target ID.

tags (vnd.net.juniper.space.tag-management.tags;version=3)

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this tags node in the current node context. This link can be used to retrieve or operate on the currently referenced tags in the tree path.
@totalIntegerYY N Total number of tags in the API result set. If paging parameters are used in the query to limit the result set size, then total represents the total number of tags in all the pages of the result set.
tagtags.tag[]NY Y *  

tags.tag

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)YY N NNLink to this tag node in the current node context. This link can be used to retrieve or operate on the currently referenced tag in the tree path.

Hyperlink Template: /api/space/tag-management/tags/{*ID}.
@hrefString(URI)NY Y * NNLink to an external tag. Here, href points to the tag in the primary tags collection.

Hyperlink Template: /api/space/tag-management/tags/{*ID}.
idIntegerYY N NNTag ID.
nameStringYY N YYTag Name.
access-typeStringYY N YYAccess Type.

tags (vnd.net.juniper.space.tag-management.tags;version=1)

This represents the collection of accessible tags for the user accessing the space. It provides the tag name, access type, total count of tagged objects, and the tag and a URI for the tag object for getting more information about it.

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)NY Y Link to this tags node in the current node context. This link can be used to retrieve or operate on the currently referenced tags in the tree path.
@sizeIntegerNY Y The size of the tag collection
tagtags.tag[]NY Y All tags inside the collection

tags.tag

A particular tag and its information.

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)NY Y NNLink to this tag node in the current node context. This link can be used to retrieve or operate on the currently referenced tag in the tree path.
@hrefString(URI)NY Y NNLink to an external tag. Here, href points to the tag in the primary tag collection.
idIntegerNY Y * NN The ID attribute of the tag
nameStringNY Y YY The name of the tag. This field supports filtering and sorting.
typeStringNY Y NN The access type of the tag. It can be either public or private. This field supports sorting.
targetstags.tag.targetsNY Y NN The access collection of targets tagged by a tag.

tags.tag.targets

A particular tag and its information.

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)NY Y Link to this targets node in the current node context. This link can be used to retrieve or operate on the currently referenced targets in the tree path.
idIntegerNY Y Tag ID.
targettags.tag.targets.target[]NY Y The collection of targets tagged by a tag.

tags.tag.targets.target

A particular tag and its information.

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@typeStringNY Y NN The media type that can be used to access the target using an HREF attribute.
@uriString(URI)NY Y NNLink to this target node in the current node context. This link can be used to retrieve or operate on the currently referenced target in the tree path.
@hrefString(URI)NY Y NNLink to an external target. Here, href points to the target in the primary target collection.
idIntegerNY Y NNTarget ID.
tagIdIntegerNY Y NNTag ID for this target.

target (vnd.net.juniper.space.tag-management.target;version=1)

This represents a single target HREF in a collection of targets for a given tag.

Field NameTypeRead OnlyGETPUT / POSTDescription
@typeStringNY Y The media type that can be used to access the target using an HREF attribute.
@uriString(URI)NY Y Link to this target node in the current node context. This link can be used to retrieve or operate on the currently referenced target in the tree path.
@hrefString(URI)NY Y * Link to an external target. Here, href points to the target in the primary target collection.
idIntegerNY Y The target ID.

targets (vnd.net.juniper.space.tag-management.targets;version=1)

This represents the collection of URIs to all tagged objects for a particular tag.

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)NY Y Link to this targets node in the current node context. This link can be used to retrieve or operate on the currently referenced targets in the tree path.
targettargets.target[]NY Y * The collection of targets tagged by a tag.

targets.target

A particular tag and its information.

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@typeStringNY Y NN The media type that can be used to access the target using an HREF attribute.
@uriString(URI)NY Y NNLink to this target node in the current node context. This link can be used to retrieve or operate on the currently referenced target in the tree path.
@hrefString(URI)NY Y * NNLink to an external target. Here, href points to the target in the primary target collection.
idIntegerNY Y NNTarget ID.

task (vnd.net.juniper.space.user-management.task;version=1)

The 'task' resource model represents details about a task present in the system. It consists of the following fields:

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)NY Y * Link to this task node in the current node context. This link can be used to retrieve or operate on the currently referenced task in the tree path.
idIntegerNY Y The unique identifier for the task.
nameStringNY Y * The name of the task.
titleStringNY Y The title of the task.
clsStringNY Y The CLS description of the task.

task (vnd.net.juniper.space.job-management.task;version=1)

Task resource returned by all Long Running Requests (LRR's) in Junos Space. Long Running Request is a REST abstraction of a Junos Space Job.

Field NameTypeRead OnlyGETPUT / POSTDescription
@hrefString(URI)NY Y Link to an external task. Here, href points to the task in the primary task collection.
idIntegerNY Y * ID of the Job which is running the Task.

task-ref (vnd.net.juniper.space.user-management.task-ref;version=3)

Task

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this task-ref node in the current node context. This link can be used to retrieve or operate on the currently referenced task-ref in the tree path.

Hyperlink Template: /api/space/user-management/roles/{*ID}/tasks/{*ID}.
@hrefString(URI)NY Y * Link to an external task-ref. Here, href points to the task-ref in the primary task-ref collection.

Hyperlink Template: /api/space/user-management/tasks/{*ID}.
idIntegerYY N Task ID.
nameStringYY N Task Name.

task-ref (vnd.net.juniper.space.user-management.task-ref;version=1)

The 'task-ref' resource model represents details about a task associated with a capability. It consists of the following fields:

Field NameTypeRead OnlyGETPUT / POSTDescription
@keyIntegerNY Y * The unique identifier for the task.
@hrefString(URI)NY Y * Link to an external task-ref. Here, href points to the task-ref in the primary task-ref collection.
@uriString(URI)NY Y * Link to this task-ref node in the current node context. This link can be used to retrieve or operate on the currently referenced task-ref in the tree path.
nameStringNY Y * The name of the task.
titleStringNY Y The title of the task.

task-refs (vnd.net.juniper.space.user-management.task-refs;version=3)

List of tasks for a role

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this task-refs node in the current node context. This link can be used to retrieve or operate on the currently referenced task-refs in the tree path.
@totalIntegerYY N Total number of tasks in the API result set. If paging parameters are used in the query to limit the result set size, then total represents the total number of tasks in all the pages of the result set.
tasktask-refs.task[]NY Y * Task.

task-refs.task

Task

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)YY N NNLink to this task node in the current node context. This link can be used to retrieve or operate on the currently referenced task in the tree path.

Hyperlink Template: /api/space/user-management/roles/{*ID}/tasks/{*ID}.
@hrefString(URI)NY Y * NNLink to an external task. Here, href points to the task in the primary task collection.

Hyperlink Template: /api/space/user-management/tasks/{*ID}.
idIntegerYY N NNTask ID.
nameStringYY N NNTask Name.
titleStringYY N NNTitle.
capability-nameStringYY N NNCapability Name.
hidden-taskBooleanYY N NNHidden Task.

Default: false.
workspace-nameStringYY N NNWorkspace Name.
workspace-titleStringYY N NNWorkspace Title.
module-nameStringYY N NNModule Name.
module-titleStringYY N NNModule Title.
parent-task-nameStringYY N NNParent Task Name.

tasks (vnd.net.juniper.space.user-management.tasks;version=1)

The 'tasks' resource model represents a view of all the tasks present in the system. The 'task' field in 'tasks' represent pull-through data. It consists of the following fields:

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)NY Y * Link to this tasks node in the current node context. This link can be used to retrieve or operate on the currently referenced tasks in the tree path.
@sizeIntegerNY Y * The total number of tasks available in the system.
tasktasks.task[]NY Y * The collection of objects of type 'task'. Each object represents a task present in the system.

tasks.task

The 'task' field of type 'task' consists of the following pull-through fields:

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
keyIntegerNY Y NN A unique identifier for a task.
nameStringNY Y NN The name of the task.
titleStringNY Y NN 
uriStringNY Y NN A link to identify the 'task' resource.
hrefStringNY Y NN The location of a task.
parent-task-nameStringNY Y NN 
workspace-nameStringNY Y NN 
workspace-titleStringNY Y NN 
module-nameStringNY Y NN 
module-titleStringNY Y NN 
capability-nameStringNY Y NN 
hidden-taskBooleanNY Y NN 

tasks-ref (vnd.net.juniper.space.user-management.tasks-ref;version=1)

The 'tasks-ref' resource model represents all the tasks associated with a capability. The 'task' field in 'tasks' represents pull-through data. It consists of the following fields:

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)NY Y * Link to this tasks-ref node in the current node context. This link can be used to retrieve or operate on the currently referenced tasks-ref in the tree path.
@sizeIntegerNY Y The total number of tasks associated with a capability.
tasktasks-ref.task[]NY Y The collection of objects of type 'task'. Each object represents a task associated with the capability.

tasks-ref.task

The 'task' field of type 'task' consists of the following pull-through fields:

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
keyIntegerNY Y NN The unique identifier for the task.
nameStringNY Y NN The name of the task.
hrefStringNY Y NN The location of a task.
uriStringNY Y NN A link to identify the task associated with a capability.

template-config-cli (vnd.net.juniper.space.config-template-management.template-config-cli;version=3)

The content of the configuration template in XML format.

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this template-config-cli node in the current node context. This link can be used to retrieve or operate on the currently referenced template-config-cli in the tree path.

Hyperlink Template: /api/space/config-template-management/config-templates/{*ID}/versions/{*ID}/configuration.
@hrefString(URI)YY N Link to an external template-config-cli. Here, href points to the template-config-cli in the primary template-config-cli collection.

Hyperlink Template: /api/space/config-template-management/config-templates/{*ID}/versions/{*ID}/configuration.
cliStringYY N Cli.

template-config-cli (vnd.net.juniper.space.config-template-management.template-config-cli;version=2)

The content of the configuration template in XML format.

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this template-config-cli node in the current node context. This link can be used to retrieve or operate on the currently referenced template-config-cli in the tree path.

Hyperlink Template: /api/space/config-template-management/templates/{*ID}/template-config.
@hrefString(URI)NY Y * Link to an external template-config-cli. Here, href points to the template-config-cli in the primary template-config-cli collection.

Hyperlink Template: /api/space/config-template-management/config-templates/{*ID}/versions/{*ID}/configuration.
cliStringYY N Cli.

template-config-xml (vnd.net.juniper.space.config-template-management.template-config-xml;version=3)

The content of the configuration template in XML format.

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this template-config-xml node in the current node context. This link can be used to retrieve or operate on the currently referenced template-config-xml in the tree path.

Hyperlink Template: /api/space/config-template-management/config-templates/{*ID}/versions/{*ID}/configuration.
@hrefString(URI)YY N Link to an external template-config-xml. Here, href points to the template-config-xml in the primary template-config-xml collection.

Hyperlink Template: /api/space/config-template-management/config-templates/{*ID}/versions/{*ID}/configuration.
xmlStringYY N Xml.

template-config-xml (vnd.net.juniper.space.config-template-management.template-config-xml;version=2)

The content of the configuration template in XML format.

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this template-config-xml node in the current node context. This link can be used to retrieve or operate on the currently referenced template-config-xml in the tree path.

Hyperlink Template: /api/space/config-template-management/templates/{*ID}/template-config.
@hrefString(URI)YY N Link to an external template-config-xml. Here, href points to the template-config-xml in the primary template-config-xml collection.

Hyperlink Template: /api/space/config-template-management/config-templates/{*ID}/versions/{*ID}/configuration.
xmlStringNY Y * The content of the configuration template in XML.

template-request-refs (vnd.net.juniper.space.config-template-management.template-request-refs;version=4)

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this template-request-refs node in the current node context. This link can be used to retrieve or operate on the currently referenced template-request-refs in the tree path.
@totalIntegerYY N Total number of template-requests in the API result set. If paging parameters are used in the query to limit the result set size, then total represents the total number of template-requests in all the pages of the result set.
template-requesttemplate-request-refs.templateRequest[]NY Y *  

template-request-refs.templateRequest

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)YY N NNLink to this templateRequest node in the current node context. This link can be used to retrieve or operate on the currently referenced templateRequest in the tree path.

Hyperlink Template: /api/space/config-template-management/templates/deploy-template-result/jobs/{*ID}/{*ID}.
@hrefString(URI)NY Y * NNLink to an external templateRequest. Here, href points to the templateRequest in the primary templateRequest collection.

Hyperlink Template: /api/space/config-template-management/template-requests-by-ids/{*ID}.
idIntegerYY N NNTemplateRequest ID.
device-idIntegerYY N NNDevice ID.
tr-idIntegerYY N NNTr ID.
cr-idIntegerYY N NNCr ID.
domain-nameStringYY N NNDomain Name.
domain-idIntegerYY N NYDomain ID.
status-nameStringYY N YYStatus Name.
xml-dataStringYY N NNXml Data.
statusenum(status)YY N YNStatus.

Possible Values:
SUCCESSSuccess
FAILUREFailure
NA 
CANCELLEDCancelled
INPROGRESSInprogress

Default: NA.
device-nameStringYY N YNDevice Name.
xml-data-replyStringYY N YNXml Data Reply.
job-idIntegerYY N NNJob ID.
device-ipStringYY N YNDevice IP.

template-versions (vnd.net.juniper.space.config-template-management.template-versions;version=2)

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this template-versions node in the current node context. This link can be used to retrieve or operate on the currently referenced template-versions in the tree path.
@totalIntegerYY N Total number of template-versions in the API result set. If paging parameters are used in the query to limit the result set size, then total represents the total number of template-versions in all the pages of the result set.
versiontemplate-versions.version[]NY Y *  

template-versions.version

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)YY N NNLink to this version node in the current node context. This link can be used to retrieve or operate on the currently referenced version in the tree path.

Hyperlink Template: /api/space/config-template-management/templates/{*ID}/template-versions/{*ID}.
@hrefString(URI)YY N NNLink to an external version. Here, href points to the version in the primary version collection.

Hyperlink Template: /api/space/config-template-management/templates/{*ID}/template-versions/{*ID}.
contentStringNY Y NNContent.
deploy-statusStringNY Y NNDeploy Status.
modified-timeDateNY Y NNModified Time.
numberStringNY Y * NNNumber.

terminate-user-session-job-results (vnd.net.juniper.space.user-management.terminate-user-session-job-results;version=3)

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this terminate-user-session-job-results node in the current node context. This link can be used to retrieve or operate on the currently referenced terminate-user-session-job-results in the tree path.
@totalIntegerYY N Total number of terminate-user-session-job-results in the API result set. If paging parameters are used in the query to limit the result set size, then total represents the total number of terminate-user-session-job-results in all the pages of the result set.
terminate-user-session-job-resultterminate-user-session-job-results.terminateUserSessionJobResult[]NY Y *  

terminate-user-session-job-results.terminateUserSessionJobResult

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)YY N NNLink to this terminateUserSessionJobResult node in the current node context. This link can be used to retrieve or operate on the currently referenced terminateUserSessionJobResult in the tree path.
job-idIntegerYY N NNJob ID.
job-statusenum(job-status)NY Y * NNJob Status.

Possible Values:
FAILEDFailed
SUCCESSSuccess
INPROGRESSInprogress
.
active-user-idStringNY Y * NNActive User Session ID.
user-ip-addrStringNY Y * NNUser's IP Address.
user-nameStringNY Y * NNUser Name.
job-descriptionStringNY Y * NNJob Description.

terminate-user-sessions-request (vnd.net.juniper.space.user-management.terminate-user-sessions-request;version=3)

Field NameTypeRead OnlyGETPUT / POSTDescription
active-user-sessionsterminate-user-sessions-request.activeUserListsNY Y *  

terminate-user-sessions-request.activeUserLists

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this activeUserLists node in the current node context. This link can be used to retrieve or operate on the currently referenced activeUserLists in the tree path.
active-user-sessionterminate-user-sessions-request.activeUserLists.activeUser[]NY Y *  

terminate-user-sessions-request.activeUserLists.activeUser

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@hrefString(URI)NY Y * NNLink to an external activeUser. Here, href points to the activeUser in the primary active-users collection.

Hyperlink Template: /api/space/user-management/active-user-sessions/{*ID}.
idIntegerYY N NNActiveUser ID.

test-connection-request (vnd.net.juniper.space.hardware-catalog.test-connection-request;version=1)

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this test-connection-request node in the current node context. This link can be used to retrieve or operate on the currently referenced test-connection-request in the tree path.
svn-trunk-urlStringNY Y * Svn Trunk Url.
svn-user-nameStringNY Y * Svn User Name.
svn-user-passwordStringNY Y * Svn User Password.

test-connection-response (vnd.net.juniper.space.hardware-catalog.test-connection-response;version=1)

Field NameTypeRead OnlyGETPUT / POSTDescription
valueBooleanNY Y * Value.

unlock-users-request (vnd.net.juniper.space.user-management.unlock-users-request;version=3)

Field NameTypeRead OnlyGETPUT / POSTDescription
usersunlock-users-request.usersNY Y *  

unlock-users-request.users

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this users node in the current node context. This link can be used to retrieve or operate on the currently referenced users in the tree path.
userunlock-users-request.users.user[]NY Y * Get all users.

unlock-users-request.users.user

Get all users

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@hrefString(URI)NY Y * NNLink to an external user. Here, href points to the user in the primary users collection.

Hyperlink Template: /api/space/user-management/users/{*ID}.
idIntegerYY N YYUser ID.
nameStringYY N YYUser Name.

unmanaged-device-request (vnd.net.juniper.space.device-management.unmanaged-device-management.unmanaged-device-request;version=7)

Field NameTypeRead OnlyGETPUT / POSTDescription
devicesunmanaged-device-request.deviceDetailssesNY Y *  

unmanaged-device-request.deviceDetailsses

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this deviceDetailsses node in the current node context. This link can be used to retrieve or operate on the currently referenced deviceDetailsses in the tree path.
deviceunmanaged-device-request.deviceDetailsses.unManagedDeviceDetails[]NY Y *  

unmanaged-device-request.deviceDetailsses.unManagedDeviceDetails

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@hrefString(URI)YY N NNLink to an external unManagedDeviceDetails. Here, href points to the unManagedDeviceDetails in the primary unManagedDeviceDetails collection.

Hyperlink Template: /api/space/device-management/unmanaged-device-management/unmanaged-device-by-device-ids/{*ID}.
passwordStringNY Y * NNPassword.
domain-nameStringNY Y NNDomain Name.
loopback-addressStringNY Y NNLoopback Address.
snmp-v3-usernameStringNY Y NNSnmp v3 Username.
communityStringNY Y NNCommunity.
vendorStringNY Y * NNVendor.
snmp-v3-auth-typeStringNY Y NNSnmp v3 Auth Type.
snmp-v1-v2-communityStringNY Y NNSnmp v1 v2 Community.
snmp-v3-privacy-typeStringNY Y NNSnmp v3 Privacy Type.
ip-addressStringNY Y NNIP Address.
snmp-v3-auth-passwordStringNY Y NNSnmp v3 Auth Password.
snmp-versionStringNY Y NNSnmp Version.
loopback-nameStringNY Y NNLoopback Name.
hostnameStringNY Y NNHostame.
usernameStringNY Y * NNUsername.
unreachableBooleanNY Y NNUnreachable.

Default: true.
snmp-v3-privacy-passwordStringNY Y NNSnmp v3 Privacy Password.
advanced-propertiesunmanaged-device-request.deviceDetailsses.unManagedDeviceDetails.advancedPropertiesNY Y NN 

unmanaged-device-request.deviceDetailsses.unManagedDeviceDetails.advancedProperties

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this advancedProperties node in the current node context. This link can be used to retrieve or operate on the currently referenced advancedProperties in the tree path.
@totalIntegerYY N Total number of gen_unmanaged-device-request-device-detailsses-device-detailsses-advanced-properties in the API result set. If paging parameters are used in the query to limit the result set size, then total represents the total number of gen_unmanaged-device-request-device-detailsses-device-detailsses-advanced-properties in all the pages of the result set.
unmanaged-device-attrunmanaged-device-request.deviceDetailsses.unManagedDeviceDetails.advancedProperties.unmanagedDeviceAttr[]NY Y *  

unmanaged-device-request.deviceDetailsses.unManagedDeviceDetails.advancedProperties.unmanagedDeviceAttr

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)YY N NNLink to this unmanagedDeviceAttr node in the current node context. This link can be used to retrieve or operate on the currently referenced unmanagedDeviceAttr in the tree path.
valueStringNY Y * NNValue.
keyStringNY Y * NNKey.

unused-schemas (vnd.net.juniper.space.schema-service.unused-schemas;version=2)

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this unused-schemas node in the current node context. This link can be used to retrieve or operate on the currently referenced unused-schemas in the tree path.
@totalIntegerYY N Total number of unused-schemas in the API result set. If paging parameters are used in the query to limit the result set size, then total represents the total number of unused-schemas in all the pages of the result set.
dmi-schema-infounused-schemas.dmiSchemaInfo[]NY Y *  

unused-schemas.dmiSchemaInfo

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)YY N NNLink to this dmiSchemaInfo node in the current node context. This link can be used to retrieve or operate on the currently referenced dmiSchemaInfo in the tree path.
os-versionStringYY N YNOs Version.
dev-familyStringYY N YNDev Family.

update-user-preference-state-request (vnd.net.juniper.space.user-management.update-user-preference-state-request;version=3)

update or create user preference state

Field NameTypeRead OnlyGETPUT / POSTDescription
user-preference-stateupdate-user-preference-state-request.updateUserPreferenceStateResponseNY Y *  
is-encodeBooleanNY Y * Is Encode.

update-user-preference-state-request.updateUserPreferenceStateResponse

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this updateUserPreferenceStateResponse node in the current node context. This link can be used to retrieve or operate on the currently referenced updateUserPreferenceStateResponse in the tree path.
idIntegerYY N UserPreferenceState ID.
state-nameStringNY Y * State Name.
state-valueStringNY Y * State Value.

update-user-preference-state-response (vnd.net.juniper.space.user-management.update-user-preference-state-response;version=3)

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this update-user-preference-state-response node in the current node context. This link can be used to retrieve or operate on the currently referenced update-user-preference-state-response in the tree path.
*idIntegerYY N UserPreferenceState ID.
state-nameStringNY Y * State Name.
state-valueStringNY Y * State Value.

upload-image-response (vnd.net.juniper.space.user-management.upload-image-response;version=3)

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this upload-image-response node in the current node context. This link can be used to retrieve or operate on the currently referenced upload-image-response in the tree path.
image-idIntegerYY N Id created for the image, after uploading.
image-nameStringNY Y * Name of the uploaded image.

upload-keys-request (vnd.net.juniper.space.device-management.upload-keys-request;version=3)

UploadKeys trigger the job instance to upload credentials to the device and returns job id

Field NameTypeRead OnlyGETPUT / POSTDescription
device-credentials-bean-listupload-keys-request.deviceCredentialsBeanListsNY Y * Device Credentials for List of Device.

upload-keys-request.deviceCredentialsBeanLists

Device Credentials for List of Device

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this deviceCredentialsBeanLists node in the current node context. This link can be used to retrieve or operate on the currently referenced deviceCredentialsBeanLists in the tree path.
device-credentials-beanupload-keys-request.deviceCredentialsBeanLists.deviceCredentialsBean[]NY Y * Device Credentials of Single Device.

upload-keys-request.deviceCredentialsBeanLists.deviceCredentialsBean

Device Credentials of Single Device

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)YY N NNLink to this deviceCredentialsBean node in the current node context. This link can be used to retrieve or operate on the currently referenced deviceCredentialsBean in the tree path.
space-user-nameStringNY Y * NNSpace User Name.
user-nameStringNY Y * NNUser Name.
host-nameStringNY Y * NNHost Name.
passwordStringNY Y * NNPassword.
ip-addressStringNY Y * NNIP Address.

upload-tgz-hardware-catalog-response (vnd.net.juniper.space.hardware-catalog.upload-tgz-hardware-catalog-response;version=1)

Field NameTypeRead OnlyGETPUT / POSTDescription
valueStringNY Y * Value.

user (vnd.net.juniper.space.user-management.user;version=3)

Get User Information by ID.

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this user node in the current node context. For primary collection members, href and uri are always the same.

Hyperlink Template: /api/space/user-management/users/{*ID}.
@hrefString(URI)NY Y * Link to an external user. Here, href points to the user in the primary users collection.

Hyperlink Template: /api/space/user-management/users/{*ID}.
*idIntegerYY N  
nameStringYY N User Id.
first-nameStringYY N First Name.
middle-nameStringYY N Middle Name.
last-nameStringYY N Last Name.
passwordStringYY N Password.
password-statusenum(password-status)YY N Password Status.

Possible Values:
ACTIVEActive
EXPIREDExpired
TEMPORARYTemporary
TEMPORARY_EXPIREDTemporary Password Expired

Default: ACTIVE.
password-expiry-dateDateYY N Password Expire Date.
statusStringYY N Status.
primary-emailStringYY N Primary Email.
primary-phoneStringYY N Primary Phone.
domain-nameStringYY N Domain Name.
api-access-profileStringYY N API Access Profile.
rolesuser.rolesYY N  
role-typeenum(role-type)YY N Role Type.

Possible Values:
GUI_ROLE_ACCESSGUI Role Access
API_ROLE_ACCESSAPI Role Access
ALL_ACCESSGUI Access and API Access

Default: ALL_ACCESS.
auth-modeStringYY N Auth Mode.

Default: "Local".
active-user-sessionsuser.activeUserSessionsYY N  
change-passwordStringYY N Change User Password.

Hyperlink Template: /api/space/user-management/users/{*ID}/change-password.
enable-userStringYY N Enable the user.

Hyperlink Template: /api/space/user-management/users/{*ID}/enable-user.
disable-userStringYY N Disable the user.

Hyperlink Template: /api/space/user-management/users/{*ID}/disable-user.
capabilitiesStringYY N Capabilities for the user.

Hyperlink Template: /api/space/user-management/users/{*ID}/capabilities.

user.roles

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this roles node in the current node context. This link can be used to retrieve or operate on the currently referenced roles in the tree path.

Hyperlink Template: /api/space/user-management/users/{*ID}/roles.
@totalIntegerYY N Total number of gen_user-roles in the API result set. If paging parameters are used in the query to limit the result set size, then total represents the total number of gen_user-roles in all the pages of the result set.
roleuser.roles.role[]NY Y *  

user.roles.role

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)YY N NNLink to this role node in the current node context. This link can be used to retrieve or operate on the currently referenced role in the tree path.

Hyperlink Template: /api/space/user-management/users/{*ID}/roles/{*ID}.
@hrefString(URI)NY Y * NNLink to an external role. Here, href points to the role in the primary roles collection.

Hyperlink Template: /api/space/user-management/roles/{*ID}.
role-idIntegerYY N NNRole ID.
nameStringYY N NNRole Name.

user.activeUserSessions

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this activeUserSessions node in the current node context. This link can be used to retrieve or operate on the currently referenced activeUserSessions in the tree path.

Hyperlink Template: /api/space/user-management/users/{*ID}/active-user-sessions.
@totalIntegerYY N Total number of gen_user-active-user-sessions in the API result set. If paging parameters are used in the query to limit the result set size, then total represents the total number of gen_user-active-user-sessions in all the pages of the result set.
active-user-sessionuser.activeUserSessions.activeUser[]NY Y *  

user.activeUserSessions.activeUser

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)YY N NNLink to this activeUser node in the current node context. This link can be used to retrieve or operate on the currently referenced activeUser in the tree path.

Hyperlink Template: /api/space/user-management/users/{*ID}/active-user-sessions/{*ID}.
@hrefString(URI)NY Y * NNLink to an external activeUser. Here, href points to the activeUser in the primary active-users collection.

Hyperlink Template: /api/space/user-management/active-user-sessions/{*ID}.
idIntegerYY N NNActiveUser ID.
nameStringYY N NNActiveUser Name.

user (vnd.net.juniper.space.user-management.user;version=1)

The 'user' resource model represents details about a user present in the system. It also displays the roles associated with a user. It consists of the following fields:

Field NameTypeRead OnlyGETPUT / POSTDescription
@read-onlyBooleanNY Y Is this user read-only?
@uriString(URI)NY Y Link to this user node in the current node context. This link can be used to retrieve or operate on the currently referenced user in the tree path.
idIntegerNY Y A unique identifier for the user.
titleStringNY Y The user's title.
nameStringNY Y * The user's name
firstNameStringNY Y * The user's first name
middleNameStringNY Y The user's middle name
lastNameStringNY Y * The user's last name
viewAllObjectsBooleanNY Y User can view all jobs or user's own jobs in job manager
passwordStringNY Y The user's password.
primaryPhoneStringNY Y The user's primary phone.
primaryEmailStringNY Y The user's primary email.
imageIdintNY Y The user's image id.
imageStringNY Y User's image
imageNameStringNY Y Name of the User's image
temporaryPasswordStringNY Y The user's temporary password
is-lockedBooleanYY N User locked out status.
password-statusenum(password-status)YY N Password status.

Possible Values:
ACTIVEActive
EXPIREDExpired
TEMPORARYTemporary
TEMPORARY_EXPIREDTemporary Password Expired
password-expiry-timeDateNY Y Password expiry time. The can be updated only when the password type is TEMPORARY. For PERSISTENT password, the expiry time is always computed based on admin configured value. If the password state is TEMPORARY and this value is not specified, the default is taken as current_time + 24 Hours.
password-expiry-hourslongNY Y Expire hour for the temporary password.
authModeStringNY Y Authorization mode of the user.
statusStringNY Y Status.
roleTypeenum(roleType)NY Y

Possible Values:
GUI_ROLE_ACCESSGUI Role Access
API_ROLE_ACCESSAPI Role Access
ALL_ACCESSGUI Access and API Access
use-global-settingsBooleanNY Y  
maximum-concurrent-ui-sessionsIntegerNY Y  
auto-logout-timeIntegerNY Y  
use-global-logout-timeBooleanNY Y  
rolesuser.rolesNY Y * The roles associated with the user.
x509-authentication-parametersuser.x509CertAuthParamMosNY Y X509 Certificate Authentication parameters associated with the user.
active-user-sessionsuser.activeUserSessionsNY Y The user sessions that are currently active for this user.
domainsuser.domainsNY Y  
api-access-profileuser.apiAccessProfileNY Y REST API access restriction rule for user.
certificate-idStringNY Y The user's certificate id.
certificate-nameStringNY Y The user's certificate name.
certificate-file-nameStringNY Y The user's certificate file name.
x509CertificateStringNY Y The user's certificate data in the string format.
methodStringNY Y The supported operations provided by Junos Space for a user .

user.roles

The 'roles' field of type 'roles' represents information about the roles associated with the user. It consists of the following fields:

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)NY Y Link to this roles node in the current node context. This link can be used to retrieve or operate on the currently referenced roles in the tree path.
roleuser.roles.userRole[]NY Y * The collection of objects of type 'userrole'. Each object represents a role associated with the user.

user.roles.userRole

The 'userroles' field of type 'userrole' consists of the following pull-through fields:

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@hrefString(URI)NY Y * NNLink to an external userRole. Here, href points to the userRole in the primary userRole collection.
@uriString(URI)NY Y NNLink to this userRole node in the current node context. This link can be used to retrieve or operate on the currently referenced userRole in the tree path.
idIntegerNY Y NN A unique identifier for the user role.
nameStringNY Y NN The name of the role.
titleStringNY Y NN 

user.x509CertAuthParamMos

x509-authentication-parameters resource model represents x509 certificate parameters information associated with the user. It consists of the following fields:

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)NY Y Link to this x509CertAuthParamMos node in the current node context. This link can be used to retrieve or operate on the currently referenced x509CertAuthParamMos in the tree path.
x509-authentication-parameteruser.x509CertAuthParamMos.x509AuthParamValue[]NY Y * Get User Information by ID.

user.x509CertAuthParamMos.x509AuthParamValue

x509-authentication-parameter consists of the fields for x509 certificate parameters. It consists of fields to hold parameter value and parameter related information like name in x509-certificate-parameter

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)NY Y NNLink to this x509AuthParamValue node in the current node context. This link can be used to retrieve or operate on the currently referenced x509AuthParamValue in the tree path.
parameter-valueStringNY Y * NNParameter Value.
x509-certificate-parameteruser.x509CertAuthParamMos.x509AuthParamValue.x509CertificateParameterNY Y * NNx509-certificate-parameter consists of the field to hold parameter name.

user.x509CertAuthParamMos.x509AuthParamValue.x509CertificateParameter

x509-certificate-parameter resource model consists of the field to hold parameter name.

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)NY Y Link to this x509CertificateParameter node in the current node context. This link can be used to retrieve or operate on the currently referenced x509CertificateParameter in the tree path.
x509-parameter-nameStringNY Y * Name of the x509 certification parameter.

user.activeUserSessions

The active-user-session resource model represents information associated with the user. It consists of the following fields:

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)NY Y Link to this activeUserSessions node in the current node context. This link can be used to retrieve or operate on the currently referenced activeUserSessions in the tree path.
active-user-sessionuser.activeUserSessions.activeUserSession[]NY Y The collection of objects of type 'active-user-session'. Each object represents a role associated with a user.

user.activeUserSessions.activeUserSession

This is information about a single user session

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@hrefString(URI)NY Y * NNLink to an external activeUserSession. Here, href points to the activeUserSession in the primary activeUserSession collection.
@uriString(URI)NY Y NNLink to this activeUserSession node in the current node context. This link can be used to retrieve or operate on the currently referenced activeUserSession in the tree path.
idIntegerNY Y NNA unique identifier for the user session.
ip-addressStringNY Y NNThe IP address of the user session.
session-start-timeStringNY Y NNThe session start time of the user session.
fabric-node-nameStringNY Y NNuser logged-in node name.

user.domains

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this domains node in the current node context. This link can be used to retrieve or operate on the currently referenced domains in the tree path.
@totalIntegerYY N Total number of gen_users-users-domains in the API result set. If paging parameters are used in the query to limit the result set size, then total represents the total number of gen_users-users-domains in all the pages of the result set.
domainuser.domains.domain[]NY Y * Domain for user.

user.domains.domain

Domain for user

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)YY N NNLink to this domain node in the current node context. This link can be used to retrieve or operate on the currently referenced domain in the tree path.

Hyperlink Template: /api/space/user-management/users/{*ID}.
@hrefString(URI)NY Y * NNLink to an external domain. Here, href points to the domain in the primary domain collection.

Hyperlink Template: /api/space/domain-management/domains/{*ID}.
idIntegerYY N NNDomain ID.
nameStringYY N NNDomain Name.

Default: "Global".

user.apiAccessProfile

Field NameTypeRead OnlyGETPUT / POSTDescription
@hrefString(URI)YY N Link to an external apiAccessProfile. Here, href points to the apiAccessProfile in the primary apiAccessProfile collection.

Hyperlink Template: /api/space/user-management/api-access-profiles/{*ID}.
idIntegerYY N Id of the api access profile.
nameStringNY Y * Name of the api access profile.
descriptionStringNY Y * Description for the api access profile.
exec-rpc-rulesuser.apiAccessProfile.rpcRulesNY Y  

user.apiAccessProfile.rpcRules

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this rpcRules node in the current node context. This link can be used to retrieve or operate on the currently referenced rpcRules in the tree path.
exec-rpc-ruleuser.apiAccessProfile.rpcRules.aPIRPCRule[]NY Y *  

user.apiAccessProfile.rpcRules.aPIRPCRule

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)YY N NNLink to this aPIRPCRule node in the current node context. This link can be used to retrieve or operate on the currently referenced aPIRPCRule in the tree path.
ruleStringNY Y * NNRPC restriction rule.

user (vnd.net.juniper.space.application-management.platform.settings.user;version=1)

The 'user' resource model represents details of "User" settings on Junos Space. It consists of following fields:

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)NY Y Link to this user node in the current node context. This link can be used to retrieve or operate on the currently referenced user in the tree path.
auto-logoutIntegerNY Y * Time in minutes for the user to be logged out automatically.
concurrent-gui-sessions-per-userIntegerNY Y *  
inactive-user-time-periodIntegerNY Y *  
ui-auto-refresh-intervalLongNY Y * Time in seconds for the UI to be refreshed automatically.

user-active-user-session (vnd.net.juniper.space.user-management.user-active-user-session;version=1)

Field NameTypeRead OnlyGETPUT / POSTDescription
@keyIntegerNY Y * The unique identifier for the user session.
@hrefString(URI)NY Y * Link to an external user-active-user-session. Here, href points to the user-active-user-session in the primary user-active-user-session collection.
@uriString(URI)NY Y * Link to this user-active-user-session node in the current node context. This link can be used to retrieve or operate on the currently referenced user-active-user-session in the tree path.
user-nameStringNY Y * Logged in user session.
ip-addressStringNY Y The IP address of the user session.
session-start-timeStringNY Y The start time of the user's session.
fabric-node-nameStringNY Y user logged-in node name.

user-active-user-sessions (vnd.net.juniper.space.user-management.user-active-user-sessions;version=1)

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)NY Y Link to this user-active-user-sessions node in the current node context. This link can be used to retrieve or operate on the currently referenced user-active-user-sessions in the tree path.
@sizeIntegerNY Y The total number of user sessions associated with a user.
active-user-sessionuser-active-user-sessions.userSession[]NY Y * The collection of objects of type 'userSession'. Each object represents a user session associated with the user.

user-active-user-sessions.userSession

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@keyIntegerNY Y NNA unique identifier for the user session.
@hrefString(URI)NY Y NNLink to an external userSession. Here, href points to the userSession in the primary userSession collection.
@uriString(URI)NY Y NNLink to this userSession node in the current node context. This link can be used to retrieve or operate on the currently referenced userSession in the tree path.
idIntegerNY Y NNThe user session id.
user-nameStringNY Y NNThe logged in user name.
ip-addressStringNY Y NNThe IP address of the user session.
session-start-timeStringNY Y NNThe start time of the user's session.
fabric-node-nameStringNY Y NNuser logged-in node name.

user-preference-state-response (vnd.net.juniper.space.user-management.user-preference-state-response;version=3)

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this user-preference-state-response node in the current node context. This link can be used to retrieve or operate on the currently referenced user-preference-state-response in the tree path.
*idIntegerYY N UserPreferenceState ID.
state-nameStringNY Y * State Name.
state-valueStringNY Y * State Value.

user-profile (vnd.net.juniper.space.user-management.user-profile;version=3)

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this user-profile node in the current node context. For primary collection members, href and uri are always the same.

Hyperlink Template: /api/space/user-management/user-profiles/{*ID}.
@hrefString(URI)YY N Link to an external user-profile. Here, href points to the user-profile in the primary user-profiles collection.

Hyperlink Template: /api/space/user-management/user-profiles/{*ID}.
*idIntegerYY N UserProfile ID.
nameStringNY Y * UserProfile Name.
titleStringNY Y * Title.
auth-modeStringNY Y * Auth Mode.
x509-cert-auth-modeStringNY Y * X509 Cert Auth Mode.

Default: "NO".

user-profiles (vnd.net.juniper.space.user-management.user-profiles;version=3)

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this user-profiles node in the current node context. This link can be used to retrieve or operate on the currently referenced user-profiles in the tree path.
@totalIntegerYY N Total number of user-profiles in the API result set. If paging parameters are used in the query to limit the result set size, then total represents the total number of user-profiles in all the pages of the result set.
user-profileuser-profiles.userProfile[]NY Y *  

user-profiles.userProfile

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)YY N NNLink to this userProfile node in the current node context. This link can be used to retrieve or operate on the currently referenced userProfile in the tree path.

Hyperlink Template: /api/space/user-management/user-profiles/{*ID}.
@hrefString(URI)YY N NNLink to an external user-profile. Here, href points to the user-profile in the primary user-profiles collection.

Hyperlink Template: /api/space/user-management/user-profiles/{*ID}.
idIntegerYY N YYUserProfile ID.
x509-cert-auth-modeStringYY N NNX509 Cert Auth Mode.

Default: "NO".
titleStringYY N YYTitle.
domain-idIntegerNY Y NNDomain ID.
nameStringYY N YYUserProfile Name.
domain-nameStringYY N NNDomain Name.
auth-modeStringYY N YYAuth Mode.

user-ref (vnd.net.juniper.space.user-management.user-ref;version=1)

The profiles resource model represents remote profiles for all users registered on a remote authentication server.

Field NameTypeRead OnlyGETPUT / POSTDescription
@hrefString(URI)NY Y * Link to an external user-ref. Here, href points to the user-ref in the primary user-ref collection.
idIntegerNY Y The unique identifier for the user.
nameStringNY Y The name of the user.

user-ref (vnd.net.juniper.space.domain-management.user-ref;version=1)

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this user-ref node in the current node context. This link can be used to retrieve or operate on the currently referenced user-ref in the tree path.

Hyperlink Template: /api/space/domain-management/domains/{*ID}/users/{*ID}.
@hrefString(URI)NY Y * Link to an external user-ref. Here, href points to the user-ref in the primary user-ref collection.

Hyperlink Template: /api/space/user-management/users/{*ID}.
*idIntegerYY N  
nameStringNY Y User Id.

user-refs (vnd.net.juniper.space.domain-management.user-refs;version=1)

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this user-refs node in the current node context. This link can be used to retrieve or operate on the currently referenced user-refs in the tree path.
@totalIntegerYY N Total number of users in the API result set. If paging parameters are used in the query to limit the result set size, then total represents the total number of users in all the pages of the result set.
useruser-refs.user[]NY Y *  

user-refs.user

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@hrefString(URI)NY Y * NNLink to an external user. Here, href points to the user in the primary user collection.

Hyperlink Template: /api/space/user-management/users/{*ID}.
@uriString(URI)YY N NNLink to this user node in the current node context. This link can be used to retrieve or operate on the currently referenced user in the tree path.

Hyperlink Template: /api/space/domain-management/domains/{*ID}/users.
primary-emailStringNY Y YYPrimary email of the user.
statusStringNY Y YYCurrent status of the user (enabled or disabled).
domainsuser-refs.user.domainsNY Y NN 
last-nameStringNY Y YY 
idIntegerYY N YY 
nameStringNY Y YY 
first-nameStringNY Y YY 

user-refs.user.domains

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this domains node in the current node context. This link can be used to retrieve or operate on the currently referenced domains in the tree path.

Hyperlink Template: /api/space/domain-management/domains/{*ID}/users/domains.
@totalIntegerYY N Total number of gen_users-users-assigned-to-domains-domains in the API result set. If paging parameters are used in the query to limit the result set size, then total represents the total number of gen_users-users-assigned-to-domains-domains in all the pages of the result set.
@hrefString(URI)NY Y Link to an external domains. Here, href points to the domains in the primary domains collection.

Hyperlink Template: /api/space/domain-management/domains/{*ID}/users/domains.
domainuser-refs.user.domains.domain[]NY Y *  

user-refs.user.domains.domain

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@hrefString(URI)NY Y * NNLink to an external domain. Here, href points to the domain in the primary domain collection.

Hyperlink Template: /api/space/domain-management/domains/{*ID}.
@uriString(URI)YY N NNLink to this domain node in the current node context. This link can be used to retrieve or operate on the currently referenced domain in the tree path.

Hyperlink Template: /api/space/domain-management/domains/{*ID}/users/domains/{*ID}.
idIntegerYY N NNID of domain.
nameStringNY Y NN 

users (vnd.net.juniper.space.user-management.users;version=3)

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this users node in the current node context. This link can be used to retrieve or operate on the currently referenced users in the tree path.
@totalIntegerYY N Total number of users in the API result set. If paging parameters are used in the query to limit the result set size, then total represents the total number of users in all the pages of the result set.
userusers.user[]NY Y * Get all users.

users.user

Get all users

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)YY N NNLink to this user node in the current node context. This link can be used to retrieve or operate on the currently referenced user in the tree path.

Hyperlink Template: /api/space/user-management/users/{*ID}.
@hrefString(URI)YY N NNLink to an external user. Here, href points to the user in the primary users collection.

Hyperlink Template: /api/space/user-management/users/{*ID}.
idIntegerYY N YYUser ID.
nameStringNY Y YYUser Name.
first-nameStringNY Y * YYFirst Name.
last-nameStringNY Y * YYLast Name.
primary-emailStringNY Y YYPrimary Email.
domainsusers.user.domainsNY Y NNAll domains this user belongs to.
auth-modeStringNY Y YYAuth Mode.

Default: "Local".
statusStringNY Y * YYStatus.
password-statusenum(password-status)NY Y YNPassword Status.

Possible Values:
ACTIVEActive
EXPIREDExpired
TEMPORARYTemporary
TEMPORARY_EXPIREDTemporary Password Expired
.
role-typeenum(role-type)NY Y YYRole Type.

Possible Values:
GUI_ROLE_ACCESSGUI Role Access
API_ROLE_ACCESSAPI Role Access
ALL_ACCESSGUI Access and API Access

Default: ALL_ACCESS.
lock-out-statusStringNY Y YYLock Out Status.
read-onlyBooleanNY Y YYThis user can only read or monitor data. Remote users (authenticated via RADIUS or TACACS+) will have read-only set to true.

Default: false.

users.user.domains

All domains this user belongs to

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this domains node in the current node context. This link can be used to retrieve or operate on the currently referenced domains in the tree path.
@totalIntegerYY N Total number of gen_users-users-domains in the API result set. If paging parameters are used in the query to limit the result set size, then total represents the total number of gen_users-users-domains in all the pages of the result set.
domainusers.user.domains.domain[]NY Y * Domain for user.

users.user.domains.domain

Domain for user

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)YY N NNLink to this domain node in the current node context. This link can be used to retrieve or operate on the currently referenced domain in the tree path.

Hyperlink Template: /api/space/user-management/users/{*ID}.
@hrefString(URI)NY Y * NNLink to an external domain. Here, href points to the domain in the primary domain collection.

Hyperlink Template: /api/space/domain-management/domains/{*ID}.
idIntegerYY N NNDomain ID.
nameStringYY N NNDomain Name.

Default: "Global".

users (vnd.net.juniper.space.user-management.users;version=1)

The 'users' resource model represents a view of all the users present in the system. The 'user' field in 'users' represents pull-through data. It consists of the following fields:

Field NameTypeRead OnlyGETPUT / POSTPATCHDescription
@uriString(URI)NY Y * NLink to this users node in the current node context. This link can be used to retrieve or operate on the currently referenced users in the tree path.
@sizeIntegerNY Y * N The size of records returned by the API
@totalIntegerNY Y * NTotal number of users in the API result set. If paging parameters are used in the query to limit the result set size, then total represents the total number of users in all the pages of the result set.
userusers.user[]NY Y * Y The collection of objects of type 'user'. Each object represents a user present in the system.

users.user

The 'user' field of type 'user' consists of the following pull-through fields:

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
keyIntegerNY Y NN A unique identifier for the user.
nameStringNY Y YY The user's name.
primaryEmailStringNY Y YY The user's primary email
primaryPhoneStringNY Y NN The user's primary phone
firstNameStringNY Y YY The user's first name
lastNameStringNY Y YY The user's last name
uriStringNY Y NN A link to identify the 'user' resource.
hrefStringNY Y NN The location of the 'user' resource.
roleTypeenum(roleType)NY Y NN

Possible Values:
GUI_ROLE_ACCESSGUI Role Access
API_ROLE_ACCESSAPI Role Access
ALL_ACCESSGUI Access and API Access
read-onlyBooleanNY Y YYIs this a read-only user?

users (vnd.net.juniper.space.domain-management.users;version=2)

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this users node in the current node context. This link can be used to retrieve or operate on the currently referenced users in the tree path.
@totalIntegerYY N Total number of users in the API result set. If paging parameters are used in the query to limit the result set size, then total represents the total number of users in all the pages of the result set.
userusers.user[]NY Y *  

users.user

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)YY N NNLink to this user node in the current node context. This link can be used to retrieve or operate on the currently referenced user in the tree path.

Hyperlink Template: /api/space/domain-management/domains/{*ID}/users/{*ID}.
@hrefString(URI)NY Y * NNLink to an external user. Here, href points to the user in the primary user collection.

Hyperlink Template: /api/space/user-management/users/{*ID}.
idIntegerYY N YY 
nameStringYY N YYUser Name.
first-nameStringYY N YYFirst Name.
middle-nameStringYY N NNMiddle Name.
last-nameStringYY N YNLast Name.
primary-emailStringYY N YYPrimary Email.
domainsusers.user.domainsYY N NN 

users.user.domains

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this domains node in the current node context. This link can be used to retrieve or operate on the currently referenced domains in the tree path.
@totalIntegerYY N Total number of gen_users-users-assigned-to-domains-domains in the API result set. If paging parameters are used in the query to limit the result set size, then total represents the total number of gen_users-users-assigned-to-domains-domains in all the pages of the result set.
domainusers.user.domains.domain[]NY Y *  

users.user.domains.domain

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@hrefString(URI)NY Y * NNLink to an external domain. Here, href points to the domain in the primary domains collection.

Hyperlink Template: /api/space/domain-management/domains/{*ID}.
idIntegerYY N NNDomain ID.
nameStringYY N NNDomain Name.
descriptionStringYY N NNDescription.

Users_patch (vnd.net.juniper.space.user-management.users_patch;version=1)

users-refs (vnd.net.juniper.space.domain-management.users-refs;version=1)

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this users-refs node in the current node context. This link can be used to retrieve or operate on the currently referenced users-refs in the tree path.
@totalIntegerYY N Total number of users in the API result set. If paging parameters are used in the query to limit the result set size, then total represents the total number of users in all the pages of the result set.
userusers-refs.user[]NY Y *  

users-refs.user

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@hrefString(URI)NY Y * NNLink to an external user. Here, href points to the user in the primary user collection.

Hyperlink Template: /api/space/user-management/users/{*ID}.
@uriString(URI)YY N NNLink to this user node in the current node context. This link can be used to retrieve or operate on the currently referenced user in the tree path.

Hyperlink Template: /api/space/domain-management/domains/{*ID}/users.
primary-emailStringNY Y YYPrimary email of the user.
auth-modeStringYY N NNAuth Mode.

Default: "Local".
statusStringNY Y YYCurrent status of the user (enabled or disabled).
domainsusers-refs.user.domainsNY Y NNLast Name.
last-nameStringNY Y YY 
idIntegerYY N YY 
nameStringNY Y YYUser Name.
first-nameStringNY Y YYFirst Name.

users-refs.user.domains

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this domains node in the current node context. This link can be used to retrieve or operate on the currently referenced domains in the tree path.

Hyperlink Template: /api/space/domain-management/domains/{*ID}/users/domains.
@totalIntegerYY N Total number of gen_users-users-assigned-to-domains-domains in the API result set. If paging parameters are used in the query to limit the result set size, then total represents the total number of gen_users-users-assigned-to-domains-domains in all the pages of the result set.
@hrefString(URI)NY Y Link to an external domains. Here, href points to the domains in the primary domains collection.

Hyperlink Template: /api/space/domain-management/domains/{*ID}/users/domains.
domainusers-refs.user.domains.domain[]NY Y *  

users-refs.user.domains.domain

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@hrefString(URI)NY Y * NNLink to an external domain. Here, href points to the domain in the primary domain collection.

Hyperlink Template: /api/space/domain-management/domains/{*ID}.
@uriString(URI)YY N NNLink to this domain node in the current node context. This link can be used to retrieve or operate on the currently referenced domain in the tree path.

Hyperlink Template: /api/space/domain-management/domains/{*ID}/users/domains/{*ID}.
idIntegerYY N NNID of domain.
nameStringNY Y NN 

validate-cli-configlet (vnd.net.juniper.space.configuration-management.validate-cli-configlet;version=1)

Validate the Configlet's configuration and its Configlet Parameters if any on the device

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this validate-cli-configlet node in the current node context. This link can be used to retrieve or operate on the currently referenced validate-cli-configlet in the tree path.
devicevalidate-cli-configlet.deviceNY Y * Unique reference to the Device for which the configlet is applicable.
contextStringNY Y Context XPATH.
cli-configlet-paramsvalidate-cli-configlet.cliConfigletParamsNY Y Collection of Configlet Parameters.

validate-cli-configlet.device

Unique reference to the Device for which the configlet is applicable

Field NameTypeRead OnlyGETPUT / POSTDescription
@hrefString(URI)NY Y * Link to an external device. Here, href points to the device in the primary device collection.

Hyperlink Template: /api/space/device-management/devices/{*ID}.
idIntegerYY N Unique ID of the Device.
nameStringYY N Device Name.

validate-cli-configlet.cliConfigletParams

Collection of Configlet Parameters

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this cliConfigletParams node in the current node context. This link can be used to retrieve or operate on the currently referenced cliConfigletParams in the tree path.
cli-configlet-paramvalidate-cli-configlet.cliConfigletParams.configletParamForNBI[]NY Y * Configlet Parameter.

validate-cli-configlet.cliConfigletParams.configletParamForNBI

Configlet Parameter

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)YY N NNLink to this configletParamForNBI node in the current node context. This link can be used to retrieve or operate on the currently referenced configletParamForNBI in the tree path.
parametervalidate-cli-configlet.cliConfigletParams.configletParamForNBI.paramForNBINY Y * NNUnique reference to the Configlet Parameter.
parameter-valueStringNY Y * NNValue for the Configlet Parameter.

validate-cli-configlet.cliConfigletParams.configletParamForNBI.paramForNBI

Unique reference to the Configlet Parameter

Field NameTypeRead OnlyGETPUT / POSTDescription
@hrefString(URI)NY Y * Link to an external paramForNBI. Here, href points to the paramForNBI in the primary paramForNBI collection.

Hyperlink Template: /api/space/configuration-management/cli-configlets/{*ID}/cli-configlet-params/{*ID}.
param-idIntegerYY N Unique ID of the Configlet Parameter.
nameStringYY N Parameter Name.
configlet-idIntegerYY N Configlet ID.

validate-cli-configlet (vnd.net.juniper.space.device-management.validate-cli-configlet;version=5)

Configlet and its Parametes list that to be validated on the Device

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this validate-cli-configlet node in the current node context. This link can be used to retrieve or operate on the currently referenced validate-cli-configlet in the tree path.
configletvalidate-cli-configlet.cliConfigurationTemplateNY Y * Unique reference to the Configlet that to be validated on the Device.
cli-configlet-paramsvalidate-cli-configlet.cliConfigletParamsNY Y Collection of Configlet Parameters.

validate-cli-configlet.cliConfigurationTemplate

Unique reference to the Configlet that to be validated on the Device

Field NameTypeRead OnlyGETPUT / POSTDescription
@hrefString(URI)NY Y * Link to an external cliConfigurationTemplate. Here, href points to the cliConfigurationTemplate in the primary cliConfigurationTemplate collection.

Hyperlink Template: /api/space/configuration-management/cli-configlets/{*ID}.
idIntegerYY N Unique ID of the Configlet.
nameStringYY N Configlet Name
The name of the configlet and it cannot exceed 255 characters. Allowable characters include dash (-), underscore (_), letters, and numbers and period (.).
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(.) characters..

validate-cli-configlet.cliConfigletParams

Collection of Configlet Parameters

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this cliConfigletParams node in the current node context. This link can be used to retrieve or operate on the currently referenced cliConfigletParams in the tree path.
cli-configlet-paramvalidate-cli-configlet.cliConfigletParams.configletParamForNBI[]NY Y * Configlet Parameter.

validate-cli-configlet.cliConfigletParams.configletParamForNBI

Configlet Parameter

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)YY N NNLink to this configletParamForNBI node in the current node context. This link can be used to retrieve or operate on the currently referenced configletParamForNBI in the tree path.
parametervalidate-cli-configlet.cliConfigletParams.configletParamForNBI.paramForNBINY Y NNUnique reference to the Configlet Parameter.
parameter-valueStringNY Y * NNValue for the Configlet Parameter.

validate-cli-configlet.cliConfigletParams.configletParamForNBI.paramForNBI

Unique reference to the Configlet Parameter

Field NameTypeRead OnlyGETPUT / POSTDescription
@hrefString(URI)NY Y * Link to an external paramForNBI. Here, href points to the paramForNBI in the primary paramForNBI collection.

Hyperlink Template: /api/space/configuration-management/cli-configlets/{*ID}/cli-configlet-params/{*ID}.
param-idIntegerYY N Unique ID of the Configlet Parameter.
nameStringYY N Parameter Name.
configlet-idIntegerYY N Configlet ID.

validate-cli-configlet-job-results (vnd.net.juniper.space.configuration-management.validate-cli-configlet-job-results;version=1)

Collection of validate cli configlet job result detail

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this validate-cli-configlet-job-results node in the current node context. This link can be used to retrieve or operate on the currently referenced validate-cli-configlet-job-results in the tree path.
@totalIntegerYY N Total number of validate-cli-configlet-job-results in the API result set. If paging parameters are used in the query to limit the result set size, then total represents the total number of validate-cli-configlet-job-results in all the pages of the result set.
validate-cli-configlet-job-resultvalidate-cli-configlet-job-results.validateCLIConfigletJobResult[]NY Y * Validate cli configlet job result detail.

validate-cli-configlet-job-results.validateCLIConfigletJobResult

Validate cli configlet job result detail

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)YY N NNLink to this validateCLIConfigletJobResult node in the current node context. This link can be used to retrieve or operate on the currently referenced validateCLIConfigletJobResult in the tree path.
idIntegerYY N NNUnique ID of the validate cli configlet job detail.
job-idIntegerYY N NNUnique ID of the job.
job-statusenum(job-status)NY Y YYStatus of validate cli configlet job.

Possible Values:
FAILEDFailed
SUCCESSSuccess
INPROGRESSInprogress
NOTSTARTEDScheduled
NOOPERATIONNo-Operation
.
job-remarksStringYY N YYValidate cli configlet job remarks.
job-percentage-completedDoubleYY N NNJob Percentage Completed.
cli-configlet-idIntegerYY N YYUnique ID of the configlet.
cli-configlet-nameStringYY N YYName of the configlet.
categoryStringYY N NNCategory of the configlet.
contextStringYY N NNContext of the configlet.
validated-configurationStringYY N NNConfiguration that is validated on the Device.
device-idIntegerYY N NNUnique ID of the device.
device-nameStringYY N YYName of the device on which the configlet is validated.
deviceStringYY N NNUnique link for the Device

Hyperlink Template: /api/space/device-management/devices/{*ID}.
jobStringYY N NNUnique link for the Job

Hyperlink Template: /api/space/job-management/jobs/{*ID}.

validate-password-request (vnd.net.juniper.space.user-management.validate-password-request;version=3)

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this validate-password-request node in the current node context. This link can be used to retrieve or operate on the currently referenced validate-password-request in the tree path.
user-nameStringNY Y * Name of the user.
passwordStringNY Y * Password string to be validated for the user. This password would be validated based on the previous passwords of the user, application settings and the user name.

validate-password-response (vnd.net.juniper.space.user-management.validate-password-response;version=3)

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)YY N Link to this validate-password-response node in the current node context. This link can be used to retrieve or operate on the currently referenced validate-password-response in the tree path.
@totalIntegerYY N Total number of validate-password-response in the API result set. If paging parameters are used in the query to limit the result set size, then total represents the total number of validate-password-response in all the pages of the result set.
error-messageString[]NY Y * Error message result after password validation.

versions-diff (vnd.net.juniper.space.config-file-management.versions-diff;version=1)

The 'versions-diff' resource model comprises a diff document which shows a difference between configuration file versions.

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)NY Y Link to this versions-diff node in the current node context. This link can be used to retrieve or operate on the currently referenced versions-diff in the tree path.
config-file-versionsversions-diff.configFileVersionMOsNY Y Versions being compared.
diffsversions-diff.contentDiffMOsNY Y List of differences.

versions-diff.configFileVersionMOs

Field NameTypeRead OnlyGETPUT / POSTDescription
config-file-versionversions-diff.configFileVersionMOs.configFileVersionMO[]NY Y A single version.

versions-diff.configFileVersionMOs.configFileVersionMO

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@hrefString(URI)NY Y NNLink to an external configFileVersionMO. Here, href points to the configFileVersionMO in the primary configFileVersionMO collection.
@uriString(URI)NY Y NNLink to this configFileVersionMO node in the current node context. This link can be used to retrieve or operate on the currently referenced configFileVersionMO in the tree path.
version-creation-timeStringNY Y NN 
idintNY Y NNVersion Href ID.
versionIdintNY Y NNVersion ID.

versions-diff.contentDiffMOs

Field NameTypeRead OnlyGETPUT / POSTDescription
diffversions-diff.contentDiffMOs.contentDiffMO[]NY Y A single difference.

versions-diff.contentDiffMOs.contentDiffMO

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
origLineStringNY Y NNOriginal value found at line number.
reasonStringNY Y NNReason for difference.
lineNumberintNY Y NNLine number where difference was found.
newLineStringNY Y NNNew value found at line number.

view-associated-devices (vnd.net.juniper.space.script-management.view-associated-devices;version=2)

The 'view-associated-devices' resource model represents the association between devices and scripts.

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)NY Y Link to this view-associated-devices node in the current node context. This link can be used to retrieve or operate on the currently referenced view-associated-devices in the tree path.
@sizeIntegerNY Y The total number of results available
script-device-associationview-associated-devices.scriptDeviceAssociationMO[]NY Y * The collection of associations. Each object in the collection represents an association between a script and a device.

view-associated-devices.scriptDeviceAssociationMO

The 'scriptDeviceAssociationMO' resource represents details about the association of the scripts and devices. It consists of following fields:

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
deviceview-associated-devices.scriptDeviceAssociationMO.deviceNY Y * NN The device type on which the operation is to be performed
script-nameStringNY Y * YY The name of the script
categoryStringNY Y YY The script category. It would be an arbitrary value used for sorting/filtering
deployed-versionStringNY Y * NN The script deployed version
script-statusenum(script-status)NY Y * NN The script status, which is enabled or disabled.

Possible Values:
ENABLEDEnabled
DISABLEDDisabled
NOTAVAILNA

view-associated-devices.scriptDeviceAssociationMO.device

Field NameTypeRead OnlyGETPUT / POSTDescription
@hrefString(URI)NY Y Link to an external device. Here, href points to the device in the primary device collection.
@uriString(URI)NY Y Link to this device node in the current node context. This link can be used to retrieve or operate on the currently referenced device in the tree path.
device-idLongNY Y * A unique identifier for the device
device-nameStringNY Y * The name of the device
ip-addressStringNY Y * The IP address of the device.

view-customized-attributes (vnd.net.juniper.space.device-management.view-customized-attributes;version=5)

FILE NAME: ElectroniclabelMOMetaDataEntityMOs.java PURPOSE: These comments are auto generated Revision History: DATE: AUTHOR: CHANGE: Mon Apr 22 18:03:34 IST 2013 Auto generated Initial Version

Field NameTypeRead OnlyGETPUT / POSTDescription
@sizeIntegerNY Y  
@uriString(URI)NY Y Link to this view-customized-attributes node in the current node context. This link can be used to retrieve or operate on the currently referenced view-customized-attributes in the tree path.
customized-attributeview-customized-attributes.electroniclabel[]NY Y *  

view-customized-attributes.electroniclabel

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
idintNY Y NN 
nameStringNY Y * NN 
valueStringNY Y * NN 

view-manage-labels (vnd.net.juniper.space.managed-domain.ptp-ref.view-manage-labels;version=3)

The 'view-managed-labels' resource model contains a list managed labels and their metadata..

Field NameTypeRead OnlyGETPUT / POSTDescription
@sizeIntegerNY Y The total size of the managed labels.
@uriString(URI)NY Y Link to this view-manage-labels node in the current node context. This link can be used to retrieve or operate on the currently referenced view-manage-labels in the tree path.
customized-attributeview-manage-labels.jSELabelMetaData[]NY Y The metadata for the managed labels.

view-manage-labels.jSELabelMetaData

The metadata for the managed labels.

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)NY Y NNLink to this jSELabelMetaData node in the current node context. This link can be used to retrieve or operate on the currently referenced jSELabelMetaData in the tree path.
@hrefString(URI)NY Y NNLink to an external jSELabelMetaData. Here, href points to the jSELabelMetaData in the primary jSELabelMetaData collection.
idintNY Y NNThe ID of the managed label.
nameStringNY Y * NNThe name of the managed label.
valueStringNY Y * NNThe data of the managed label.

virtual-chassis (vnd.net.juniper.space.managed-domain.virtual-chassis;version=1)

The 'virtual-chassis' resource model contains information if a virtual chassis exists for a managed element. It consists of the following fields:

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)NY Y Link to this virtual-chassis node in the current node context. This link can be used to retrieve or operate on the currently referenced virtual-chassis in the tree path.
chassis-existsStringNY Y This field indicates whether a virtual chassis exists for the managed element. True if true if virtual chassis exists. Otherwise, the value is false.

vlans (vnd.net.juniper.space.managed-domain.vlans;version=1)

The'vlans' resource model contains information about VLANs where a managed element exists. It is a complex type and consists of the following fields:

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)NY Y Link to this vlans node in the current node context. This link can be used to retrieve or operate on the currently referenced vlans in the tree path.
@sizeIntegerNY Y The size of the collection
vlanvlans.vLAN[]NY Y The collection of VLANs

vlans.vLAN

The 'vlan' type contains information about a single VLAN and pull-through fields

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
descriptionStringNY Y NNA description of the VLAN
vlanIdIntegerNY Y * NNThe ID of the VLAN
vlanRangeStringNY Y NNThe VLAN ID range
l3InterfaceStringNY Y NN The routing interface, which includes a bridge domain or a VPLS routing instance
vlanTypeStringNY Y NNType of VLAN.

xpath (vnd.net.juniper.space.device-management.xpath;version=1)

The 'xpath' resource model represents a view of information about the the retrieved configuration based on an XPath. It consists of the following fields:

Field NameTypeRead OnlyGETPUT / POSTDescription
xpathString[]NY Y * XPath to be passed to get the configuration.

Deprecated

This section lists all deprecated media types.

change-request (vnd.net.juniper.space.configuration-management.change-request;version=1)

The 'change-request' resource model represents details about a change-request. It also displays detailed information about the device on which this change-request was posted. It consists of the following fields:

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)NY Y Link to this change-request node in the current node context. This link can be used to retrieve or operate on the currently referenced change-request in the tree path.
idIntegerNY Y * A unique identifier for the change-request.
nameStringNY Y Name of the change request.
descriptionStringNY Y Description for the change request.
xmlDataStringNY Y The configuration data needed for the change request.
devicechange-request.deviceNY Y * The representation of the device.
syncAfterPushBooleanNY Y Whether to re-synchronize the device after the configuration update or not.

change-request.device

The 'device' field of 'device' type provides detailed information about the device on which the change request was created. It consists of the following fields:

Field NameTypeRead OnlyGETPUT / POSTDescription
@hrefString(URI)NY Y Link to an external device. Here, href points to the device in the primary device collection.
@uriString(URI)NY Y Link to this device node in the current node context. This link can be used to retrieve or operate on the currently referenced device in the tree path.
idLongNY Y Unique identifier for the device.
deviceFamilyStringNY Y Family of the device.
OSVersionStringNY Y Version of operating system on the device.
platformStringNY Y Platform of the device.
serialNumberStringNY Y Serial Number of the device
connectionStatusStringNY Y Connection status of the device
ipAddrStringNY Y IP Address of the device.
managedStatusStringNY Y Managed status of the device.
nameStringNY Y Name of the device.
hostNameStringNY Y Host Name of the device.
otpStringNY Y One time password of the device.

discover-devices (vnd.net.juniper.space.device-management.discover-devices;version=1)

The 'discover-devices' resource model consists of the following fields:

Field NameTypeRead OnlyGETPUT / POSTDescription
ruleNameStringNY Y * Unique rule name
discoveryMethodsDiscoveryTarget[]NY Y Discovery target schemes
usePingBooleanNY Y A flag for using ping
useSnmpBooleanNY Y A flag for using SNMP
snmpSettingsSnmpSetting[]NY Y SNMP setting schemes
manageDiscoveredSystemsFlagBooleanNY Y Boolean for managing the discovery system
credentialsCredential[]NY Y List of credentials for testing the connectivity of the discovered system. The credentials will be tried on the discovered system one by one until a credential succeeds or all of the credentials fail.
tagNewlyManagedDiscoveredSystemsFlagBooleanNY Y Boolean to tag newly discovered systems
tagForNewlyManagedDiscoveredSystemsStringNY Y Tag name to tag newly discovered systems

equipment-holder (vnd.net.juniper.space.managed-domain.equipment-holder;version=1)

The 'equipment-holder' resource model contains information for a single equipment holder. It consists of the following fields:

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)NY Y NNLink to this equipment-holder node in the current node context. This link can be used to retrieve or operate on the currently referenced equipment-holder in the tree path.
idIntegerNY Y * NN The ID of the equipment holder
nameStringNY Y NN The name of the equipment holder
pathStringNY Y NN The location of the element in the managed element
aliasStringNY Y NN
containedEquipmentequipment-holder[]NY Y NN The equipment and equipment holders directly contained by this equipment holder
holderTypeStringNY Y NN The current type of the equipment holder with respect to the contained equipment
holderStateStringNY Y NN The current condition of the equipment holder with respect to the contained equipment
expectedOrInstalledEquipmentrouting-engineNY Y NN The equipment that is installed or is expected to be installed in the physical container represented by the equipment holder

exec-deploy (vnd.net.juniper.space.script-management.exec-deploy;version=1)

This resource model represents a user's view of all accessible resources in the space. The 'scriptmgmts' type in 'scriptMgmts' represents pull-through data. The "scriptmgmts" type is a complex type and consists of following pull-through fields:

Field NameTypeRead OnlyGETPUT / POSTDescription
scriptMgmtexec-deploy.scriptMgmt[]NY Y * The set of inputs for the operation
forceRemovebooleanNY Y A flag that indicates whether to forcibly remove the association between a device and a script while removing script from the device.

exec-deploy.scriptMgmt

The 'scriptMgmt' resource model represents information about the parameters to be passed to device and that correspond to the script related operations. It consists of the following fields:

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
scriptIdIntegerNY Y * NN The ID of the script.
scriptVersionSelectedFloatNY Y NNThe version of the script.
deviceIdIntegerNY Y * NN The ID of the device on which to perform the operation.
scriptParamexec-deploy.scriptParams[]NY Y NN The list of parameters needed by the script.

exec-deploy.scriptParams

The 'scriptParam' resource model represents information about the parameters related to the script. These parameters are useful in script deployment. It consists of the following fields:

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
paramNameStringNY Y * NN The parameter name.
paramValueStringNY Y * NN The parameter value.

expanded-configuration (vnd.net.juniper.space.device-management.expanded-configuration;version=2)

The 'expanded-configuration' resource model represents access configuration data with configuration groups expanded (using the inherit="inherit" option on the Junos OS "get-configuration" RPC) of a device. It can further be defined by the following fields:

Field NameTypeRead OnlyGETPUT / POSTDescription
configurationStringNY Y * The configuration string.
idIntegerNY Y Unique identifier for expanded configuration
methodStringNY Y This represent a link to a POST method that is used to match the content of the configuration.

job (vnd.net.juniper.space.job-management.job;version=1)

The 'job' resource model represents a view of the information about the job. The job resource model consists of the following fields:

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)NY Y * Link to this job node in the current node context. This link can be used to retrieve or operate on the currently referenced job in the tree path.
idIntegerNY Y * The ID of the job
nameStringNY Y * The name of the job
percentDoubleNY Y * The percent of job completion
statusenum(status)NY Y * The job status

Possible Values:
UNDETERMINED 
INCOMPLETE 
FAILURE 
SUCCESS 
CANCELLED 
jobTypeStringNY Y The job type.
summaryStringNY Y A summary of the job
scheduledStartTimeStringNY Y The scheduled start time
userStringNY Y The user
recurrenceStringNY Y A flag that indicates whether the job is recurring.
progress-updatejob.progressUpdateNY Y A type containing the location of the job's progress update

job.progressUpdate

The 'progressUpdate'type provides a link to a job's progress update information.

Field NameTypeRead OnlyGETPUT / POSTDescription
hrefStringNY Y The link to job's progress update

jobs (vnd.net.juniper.space.job-management.jobs;version=1)

The 'jobs' resource model represents a view of all the jobs present in the system. The 'job' field in 'jobs' represents pull-through data. It consists of the following fields:

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)NY Y * Link to this jobs node in the current node context. This link can be used to retrieve or operate on the currently referenced jobs in the tree path.
@sizeIntegerNY Y The total number of jobs available in the system
jobjobs.job[]NY Y A type containing pull-through data for a job.

jobs.job

The 'job' field of type 'job' consists of the following pull-through fields for one job:

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
hrefStringNY Y NN The location of the 'job' resource.
uriStringNY Y NN A link to identify the the 'job' resource
keyIntegerNY Y YY A unique identifier for the job.
nameStringNY Y NN The name of the job.
recurringBooleanNY Y NN A flag that indicates whether the job is recurring or not.
statusenum(status)NY Y NN The job status

Possible Values:
UNDETERMINED 
INCOMPLETE 
FAILURE 
SUCCESS 
CANCELLED 
stateenum(state)NY Y NN The job state

Possible Values:
SCHEDULED 
QUEUED 
STARTING 
INPROGRESS 
DONE 
CANCELLING 
DISABLED 
userStringNY Y YY The user who created the job.

match-expanded-content (vnd.net.juniper.space.device-management.match-expanded-content;version=1)

The resource model is used to match configuration content of a device with configuration groups, for example, using the inherit="inherit" option on the Junos OS 'get-configuration' RPC. The resource model consists of the following fields:

Field NameTypeRead OnlyGETPUT / POSTDescription
deviceFamilyStringNY Y * Device family
deviceConfigStringNY Y * Device configuration

match-expanded-content (vnd.net.juniper.space.device-management.match-expanded-content;version=1)

The 'match-expanded-content' resource model is used to audit configuration content of a device. The resource model consists of the following fields:

Field NameTypeRead OnlyGETPUT / POSTDescription
statusCodeStringNY Y Status code
mergedConfigletStringNY Y Merged configlet
errorMessageStringNY Y Error message
errorDetailsStringNY Y Error details
rpc_replyStringNY Y RPC reply
rpc_requestStringNY Y RPC request

match-expanded-content (vnd.net.juniper.space.device-management.match-expanded-content;version=1)

The 'match-expanded-content' resource model is used to audit configuration content of a device. The resource model consists of the following fields:

Field NameTypeRead OnlyGETPUT / POSTDescription
statusCodeStringNY Y Status code
mergedConfigletStringNY Y Merged configlet
errorMessageStringNY Y Error message
errorDetailsStringNY Y Error details
rpc_replyStringNY Y RPC reply
rpc_requestStringNY Y RPC request

password (vnd.net.juniper.space.user-management.password;version=1)

The 'password' resource model represents a password change for a user. It consists of the following fields:

Field NameTypeRead OnlyGETPUT / POSTDescription
oldPasswordStringNY Y * The user's old password
newPasswordStringNY Y * The user's new password.

raw-configuration (vnd.net.juniper.space.device-management.raw-configuration;version=2)

The 'raw-configuration' resource model represents access to raw configuration content of a device without expanding configuration groups. It can be further defined by the following fields:

Field NameTypeRead OnlyGETPUT / POSTDescription
configurationStringNY Y * The configuration string.
idIntegerNY Y The configuration string.
methodStringNY Y This represent a link to a POST method that is used to match the content of the configuration.

role (vnd.net.juniper.space.user-management.role;version=1)

The 'role' resource model represents details about a role specified by a role ID. It also displays the capabilities associated with a role. It consists of the following fields:

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)NY Y * Link to this role node in the current node context. This link can be used to retrieve or operate on the currently referenced role in the tree path.
idIntegerNY Y * The unique identifier for the role.
nameStringNY Y * The name of the role.
titleStringNY Y The title of the role.
descriptionStringNY Y The description of the role.
capabilitiesrole.capabilitiesNY Y The capabilities associated with the role.

role.capabilities

The 'capabilities' field of type 'capabilities' represents information about the capabilities associated with the role. It consists of the following fields:

Field NameTypeRead OnlyGETPUT / POSTDescription
capabilityrole.capabilities.roleCapability[]NY Y The collection of objects of type 'rolecapability'. Each object represents a capability associated with the role.
uriStringNY Y A link to identify the capabilities associated with a role.

role.capabilities.roleCapability

The 'capabilities' field of type 'rolecapability' consists of the following pull-through fields:

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
idIntegerNY Y NN A unique identifier for the role capability.
nameStringNY Y NN The name of the capability.
hrefStringNY Y NN The location of a capability.
uriStringNY Y NN A link to identify the capabilities associated with the role.

roles (vnd.net.juniper.space.user-management.roles;version=1)

The 'roles' resource model represents a view of all the roles present in the system. The 'role' field in 'roles' represent pull-through data. It consists of the following fields:

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)NY Y * Link to this roles node in the current node context. This link can be used to retrieve or operate on the currently referenced roles in the tree path.
@sizeIntegerNY Y * The total number of roles available in the system.
roleroles.role[]NY Y * The collection of objects of type 'role'. Each object represents a role present in the system.

roles.role

The 'role' field of type 'role' consists of the following pull-through fields:

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
keyIntegerNY Y NN A unique identifier for the role.
nameStringNY Y NN The name of the role.
uriStringNY Y NN A link to identify the 'role' resource.
hrefStringNY Y NN The location of the 'role' resource.

scripts (vnd.net.juniper.space.script-management.scripts;version=1)

The 'scripts' resource model represents all available scripts in the system. The 'scripts' type in 'scripts' represent pull-through data. It consists of the following pull-through fields:

Field NameTypeRead OnlyGETPUT / POSTDescription
@sizeIntegerNY Y Size of the resource collection
@uriString(URI)NY Y Link to this scripts node in the current node context. This link can be used to retrieve or operate on the currently referenced scripts in the tree path.
scriptscripts.scriptMO[]NY Y * The scripts that are available on Junos Space.
methodStringNY Y The supported operations for scripts provided by Junos Space.
methodStringNY Y The Supported operations for scripts provided by Junos Space.

scripts.scriptMO

The 'scripts' resource model represents a user's view of accessible script resources in the space. The 'scriptMO' type in 'scripts' represents pull-through data. The 'scriptMO' type is a complex type and consists of following pull-through fields:

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
@uriString(URI)NY Y NNLink to this scriptMO node in the current node context. This link can be used to retrieve or operate on the currently referenced scriptMO in the tree path.
@hrefString(URI)NY Y NNLink to an external scriptMO. Here, href points to the scriptMO in the primary scriptMO collection.
@keyStringNY Y NN The ID of the script
scriptNameStringNY Y * YY The name of the script.
categoryStringNY Y YY Category of the script. It could be a arbitrary value used for sorting/filtering
domain-nameStringNY Y NN 
domain-idIntegerNY Y NN 

scripts-results (vnd.net.juniper.space.script-management.scripts-results;version=1)

The 'script-result' resource model represents a user's view of all accessible resources in the space. It consists of following fields:

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)NY Y Link to this scripts-results node in the current node context. This link can be used to retrieve or operate on the currently referenced scripts-results in the tree path.
@sizeIntegerNY Y Total number of results available.
scriptResultscripts-results.scriptMgmtJobResultMO[]NY Y * The collection of results. Each object in the collection represents verification result for a script.

scripts-results.scriptMgmtJobResultMO

The 'scriptResult' field of type 'scriptResult' represents the results of the operation performed on the script. It consists of the following fields:

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
scriptIDIntegerNY Y NNThe script ID.
scriptNameStringNY Y * NN The name of the script.
deviceIdIntegerNY Y * NN The identifier for the device on which the script was executed
actionTypeenum(actionType)NY Y * NN The type of action performed on the script.

Possible Values:
Transfer_ScriptTransfer Scripts to Devices
Enable_ScriptEnable Scripts on Devices
Disable_ScriptDisable Scripts on Devices
Remove_ScriptRemove Scripts from Devices
Deploy_ScriptStage Scripts on Devices
Verify_ScriptVerify Scripts on Devices
Execute_ScriptExecute Script on Devices
Deploy_Script_BundleStage Script Bundle on Devices
Execute_Script_BundleExecute Script Bundle on Devices
Enable_Script_BundleEnable Script Bundle on Devices
Disable_Script_BundleDisable Script Bundle on Devices
scriptMgmtJobStatusenum(scriptMgmtJobStatus)NY Y * NN The status of the action performed.

Possible Values:
FAILEDFailed
SUCCESSSuccess
INPROGRESSInprogress
NOTSTARTEDScheduled
NOOPERATIONNo-Operation
jobRemarksStringNY Y NN Remarks for the performed action.

view-associated-devices (vnd.net.juniper.space.script-management.view-associated-devices;version=1)

This resource model represents the association between devices and scripts.

Field NameTypeRead OnlyGETPUT / POSTDescription
@uriString(URI)NY Y Link to this view-associated-devices node in the current node context. This link can be used to retrieve or operate on the currently referenced view-associated-devices in the tree path.
@sizeIntegerNY Y Total number of results available.
script-device-associationview-associated-devices.scriptDeviceAssociationMO[]NY Y * The collection of associations. Each object in the collection represents an association between a script and a device.

view-associated-devices.scriptDeviceAssociationMO

The 'scriptDeviceAssociationMO' type represents details about the association of the scripts and devices. It consists of the following fields:

Field NameTypeRead OnlyGETPUT / POSTSortFilterDescription
deviceview-associated-devices.scriptDeviceAssociationMO.deviceNY Y * NNThe Device HREF on which the script is run.
script-nameStringNY Y * YY The name of the script
categoryStringNY Y YY Category of the script. It would be an arbitrary value used for sorting/filtering
deployed-versionStringNY Y * NN The script deployed version.
script-statusenum(script-status)NY Y * NN The script status, which is enabled or disabled

Possible Values:
ENABLEDEnabled
DISABLEDDisabled
NOTAVAILNA

view-associated-devices.scriptDeviceAssociationMO.device

Field NameTypeRead OnlyGETPUT / POSTDescription
@hrefString(URI)NY Y Link to an external device. Here, href points to the device in the primary device collection.
@uriString(URI)NY Y Link to this device node in the current node context. This link can be used to retrieve or operate on the currently referenced device in the tree path.
device-idLongNY Y * A unique identifier for the device.
device-nameStringNY Y * The name of the device.
ip-addressStringNY Y * The IP address of the device.