NSGUpgradeProfile

Upgrade information that can be given to an NSG Instance. The profile contains details on where the NSG can retrieve the image to upgrade to and some criteria related to when the upgrade is to happen once the NSG device has received the information for upgrading.

Overview

description string
enterpriseID string filterable   orderable  
entityScope enum (ENTERPRISE | GLOBAL) autogenerated  
externalID string filterable   orderable   locally unique  
lastUpdatedBy string autogenerated  
metadataUpgradePath string required  
name string creation only   filterable   orderable   locally unique  

API Resource

/nsgupgradeprofiles/id
delete get put

Parents

/nsgupgradeprofiles
get post

Children

This object has no children.

Members

This object has no members.

Attributes documentation

description string
Discussion

A concise description of the NSG Upgrade Profile that gives a small preview of its use.


Charateristics

Format: free
Max length: 255
SDK attribute: description

enterpriseID string filterable   orderable  
Discussion

Enterprise/Organisation associated with this Upgrade Profile instance.


Charateristics

Format: free
SDK attribute: enterpriseID

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

lastUpdatedBy string autogenerated  
Discussion

ID of the user who last updated the object.


Charateristics

Format: free
SDK attribute: lastUpdatedBy

metadataUpgradePath string required  
Discussion

Path/URL to retrieve the NSG Upgrade information meta data files. From that meta data, the NSG will be able to retrieve the upgrade package files and perform some validations.


Charateristics

Allowed characters: URL supported characters.
Format: free
Min length: 1
Max length: 2048
SDK attribute: metadataUpgradePath

name string creation only   filterable   orderable   locally unique  
Discussion

A unique name set by an operator identifying the NSG Upgrade Profile.


Charateristics

Allowed characters: Primarily alphanumerical (with space, _, and -)
Format: free
Min length: 1
Max length: 127
SDK attribute: name