Bootstrap

Gateway bootstrap details.

Overview

activationURL string read only  
associatedEntityType string read only   filterable  
creationDate string read only   autogenerated   orderable  
embeddedMetadata list read only   autogenerated  
entityScope enum (ENTERPRISE | GLOBAL) autogenerated  
externalID string filterable   orderable   locally unique  
installerID string
lastUpdatedBy string autogenerated  
lastUpdatedDate string read only   autogenerated   orderable  
owner string autogenerated  
status enum (ACTIVE | CERTIFICATE_SIGNED | INACTIVE | MIGRATING | NOTIFICATION_APP_REQ_ACK | NOTIFICATION_APP_REQ_SENT | QUARANTINED | REVOKED)
ZFBInfo string filterable   orderable  
ZFBMatchAttribute enum (HOSTNAME | IP_ADDRESS | MAC_ADDRESS | NONE | NSGATEWAY_ID | SERIAL_NUMBER | UUID) filterable   orderable  
ZFBMatchValue string filterable   orderable  

API Resource

/bootstraps/id
get put

Parents

/netconfgateways/id/bootstraps
get
/gateways/id/bootstraps
get
/nsgateways/id/bootstraps
get

Children

/bootstraps/id/permissions
delete get post put
/bootstraps/id/metadatas
get post
/bootstraps/id/globalmetadatas
get post put

Members

This object has no members.

Attributes documentation

activationURL string read only  
Discussion

The activation URL used for bootstrapping this instance of the NSG. If the current configuration of the NSG is incomplete, no link will be returned.

Charateristics

Format: free
SDK attribute: activationURL

associatedEntityType string read only   filterable  
Discussion

Object type of the associated entity.

Charateristics

Format: free
SDK attribute: associatedEntityType

creationDate string read only   autogenerated   orderable  
Discussion

Time stamp when this object was created.

Charateristics

SDK attribute: creationDate

embeddedMetadata list read only   autogenerated  
Discussion

Metadata objects associated with this entity. This will contain a list of Metadata objects if the API request is made using the special flag to enable the embedded Metadata feature. Only a maximum of Metadata objects is returned based on the value set in the system configuration.

Charateristics

SDK attribute: embeddedMetadata

entityScope enum autogenerated  
Discussion

Specify if scope of entity is Data center or Enterprise level

Charateristics

Allowed values: ENTERPRISE, GLOBAL
SDK attribute: entityScope

externalID string filterable   orderable   locally unique  
Discussion

External object ID. Used for integration with third party systems

Charateristics

Format: free
SDK attribute: externalID

installerID string
Discussion

The Installer ID

Charateristics

Format: free
SDK attribute: installerID

lastUpdatedBy string autogenerated  
Discussion

ID of the user who last updated the object.

Charateristics

Format: free
SDK attribute: lastUpdatedBy

lastUpdatedDate string read only   autogenerated   orderable  
Discussion

Time stamp when this object was last updated.

Charateristics

SDK attribute: lastUpdatedDate

owner string autogenerated  
Discussion

Identifies the user that has created this object.

Charateristics

Format: free
SDK attribute: owner

status enum
Discussion

Value showing the bootstrapping or activation status of an NSG or eVDF instance.

Charateristics

Allowed values: ACTIVE, CERTIFICATE_SIGNED, INACTIVE, MIGRATING, NOTIFICATION_APP_REQ_ACK, NOTIFICATION_APP_REQ_SENT, QUARANTINED, REVOKED
SDK attribute: status

ZFBInfo string filterable   orderable  
Discussion

Base64 Encoded JSON String of NSG ZFB Attribute Value Pairs

Charateristics

Format: free
SDK attribute: ZFBInfo

ZFBMatchAttribute enum filterable   orderable  
Discussion

Attribute to auto match on

Charateristics

Allowed values: HOSTNAME, IP_ADDRESS, MAC_ADDRESS, NONE, NSGATEWAY_ID, SERIAL_NUMBER, UUID
SDK attribute: ZFBMatchAttribute

ZFBMatchValue string filterable   orderable  
Discussion

Attribute value to auto match on

Charateristics

Format: free
SDK attribute: ZFBMatchValue