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