ZFBRequest

Pending requests reflect Network Services Gateways that have initiated request for bootstrapping. Requests can be assigned, or matched, to continue the bootstrapping process. If a request is rejected, the NSG will terminate the auto-bootstrapping attempts.

Overview

associatedEnterpriseID string
associatedEnterpriseName string
associatedEntityType enum (GATEWAY | NSGATEWAY) read only   filterable  
associatedGatewayID string
associatedGatewayName string read only  
associatedNSGatewayID string
associatedNSGatewayName string
CPUType string
creationDate string read only   autogenerated   orderable  
embeddedMetadata list read only   autogenerated  
entityScope enum (ENTERPRISE | GLOBAL) autogenerated  
externalID string filterable   orderable   locally unique  
family string
hostname string
IPAddress string
lastConnectedTime time autogenerated   filterable   orderable  
lastUpdatedBy string autogenerated  
lastUpdatedDate string read only   autogenerated   orderable  
MACAddress string
NSGVersion string
originalEnterpriseName string read only  
originalGatewayDatapathID string read only  
originalGatewayName string read only  
originalUplinkConnectionInfo string read only  
owner string autogenerated  
registrationURL string
requestType enum (MIGRATING | SELF_REBOOTSTRAP | ZFB)
serialNumber string
SKU string
statusString string filterable   orderable  
UUID string
ZFBApprovalStatus enum (APPROVED | ASSIGNED | DENIED | UNASSIGNED) filterable   orderable  
ZFBBootstrapEnabled boolean
ZFBInfo string filterable   orderable  
ZFBRequestRetryTimer integer

API Resource

/zfbrequests/id
delete get put

Parents

/enterprises/id/zfbrequests
get post
/zfbrequests
get post

Children

/zfbrequests/id/permissions
delete get post put
/zfbrequests/id/metadatas
get post
/zfbrequests/id/globalmetadatas
get post put
/zfbrequests/id/jobs
post

Members

This object has no members.

Attributes documentation

associatedEnterpriseID string
Discussion

the ID of the associated enteprise

Charateristics

Format: free
SDK attribute: associatedEnterpriseID

associatedEnterpriseName string
Discussion

Name of the associated enterprise

Charateristics

Format: free
SDK attribute: associatedEnterpriseName

associatedEntityType enum read only   filterable  
Discussion

Associated Entity Type: NSGATEWAY or GATEWAY

Charateristics

Allowed values: GATEWAY, NSGATEWAY
Format: free
SDK attribute: associatedEntityType

associatedGatewayID string
Discussion

ID of the assigned Gateway

Charateristics

Format: free
SDK attribute: associatedGatewayID

associatedGatewayName string read only  
Discussion

Name of the associated Gateway

Charateristics

Format: free
SDK attribute: associatedGatewayName

associatedNSGatewayID string
Discussion

ID of the assigned NSG

Charateristics

Format: free
SDK attribute: associatedNSGatewayID

associatedNSGatewayName string
Discussion

Name of the associated NSG

Charateristics

Format: free
SDK attribute: associatedNSGatewayName

CPUType string
Discussion

Processor Type

Charateristics

Format: free
SDK attribute: CPUType

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

family string
Discussion

Gateway Type

Charateristics

Format: free
SDK attribute: family

hostname string
Discussion

Hostname of the gateway bootstrapped using ZFB.

Charateristics

Format: free
SDK attribute: hostname

IPAddress string
Discussion

IP Address of the gateway being bootstrapped using ZFB.

Charateristics

Format: free
SDK attribute: IPAddress

lastConnectedTime time autogenerated   filterable   orderable  
Discussion

The time in which the last GET was made from the gateway.

Charateristics

SDK attribute: lastConnectedTime

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

MACAddress string
Discussion

MAC Address fo the NSG Port1 interface

Charateristics

Format: free
SDK attribute: MACAddress

NSGVersion string
Discussion

The Nuage NSG Version

Charateristics

Format: free
SDK attribute: NSGVersion

originalEnterpriseName string read only  
Discussion

For an NSG that is self-rebootstrapping following a quarantine action, this field represents the original name of the enterprise/organisation to which the NSG belonged.

Charateristics

Format: free
Max length: 255
SDK attribute: originalEnterpriseName

originalGatewayDatapathID string read only  
Discussion

For an NSG that is self-rebootstrapping following a quarantine action, this field represents the original datapath ID that it had before revoking.

Charateristics

Format: free
Max length: 255
SDK attribute: originalGatewayDatapathID

originalGatewayName string read only  
Discussion

For an NSG that is self-rebootstrapping following a quarantine action, this field represents the original name the gateway had before revoking.

Charateristics

Format: free
Max length: 255
SDK attribute: originalGatewayName

originalUplinkConnectionInfo string read only  
Discussion

For an NSG that is self-rebootstrapping following a quarantine action, this field represents an information blob of the original uplink connection information that applied to this NSG.

Charateristics

Format: free
Max length: 4096
SDK attribute: originalUplinkConnectionInfo

owner string autogenerated  
Discussion

Identifies the user that has created this object.

Charateristics

Format: free
SDK attribute: owner

registrationURL string
Discussion

Registration URL to be used for a gateway to be bootstrapped using ZFB.

Charateristics

Format: free
SDK attribute: registrationURL

requestType enum
Discussion

Value that serves in indicating if the Auto-Bootstrapping request is made in the context of a new NSG instance being bootstrapped or an NSG going through a self-rebootstrapping phase following a revocation triggered by entering quarantine.

Charateristics

Allowed values: MIGRATING, SELF_REBOOTSTRAP, ZFB
SDK attribute: requestType

serialNumber string
Discussion

The gateway's Serial Number.

Charateristics

Format: free
SDK attribute: serialNumber

SKU string
Discussion

The part number of the gateway being bootstrapped through ZFB.

Charateristics

Format: free
SDK attribute: SKU

statusString string filterable   orderable  
Discussion

Extra status info

Charateristics

Format: free
SDK attribute: statusString

UUID string
Discussion

Redhat UUID

Charateristics

Format: free
SDK attribute: UUID

ZFBApprovalStatus enum filterable   orderable  
Discussion

the status of the request

Charateristics

Allowed values: APPROVED, ASSIGNED, DENIED, UNASSIGNED
SDK attribute: ZFBApprovalStatus

ZFBBootstrapEnabled boolean
Discussion

whether the NSG should bootstrap, or just simulate bootstrap. Set from System Config

Charateristics

SDK attribute: ZFBBootstrapEnabled

ZFBInfo string filterable   orderable  
Discussion

The Base64 encoded JSON string of ZFB Attributes

Charateristics

Format: free
SDK attribute: ZFBInfo

ZFBRequestRetryTimer integer
Discussion

ZFB Request retry timer on the gateway. Set on VSD's System Config panel.

Charateristics

SDK attribute: ZFBRequestRetryTimer