NSGPatchProfile

An NSG Patch Profile contains 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 filterable   orderable  
enterpriseID string
entityScope enum (ENTERPRISE | GLOBAL) autogenerated  
externalID string filterable   orderable   locally unique  
lastUpdatedBy string autogenerated  
name string required   creation only   filterable   orderable  
patchTag string read only   filterable   orderable  
patchURL string required  

API Resource

/nsgpatchprofiles/id
delete get put

Parents

/nsgpatchprofiles
get post

Children

This object has no children.

Members

This object has no members.

Attributes documentation

description string filterable   orderable  
Discussion

A brief description of this patch profile.


Charateristics

Format: free
Max length: 255
SDK attribute: description

enterpriseID string
Discussion

Enterprise/Organisation that this patch profile belongs to.


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

name string required   creation only   filterable   orderable  
Discussion

A unique name identifying this patch profile.


Charateristics

Format: free
Min length: 1
Max length: 255
SDK attribute: name

patchTag string read only   filterable   orderable  
Discussion

A unique brief name and version of the patch derived from Patch URL.


Charateristics

Format: free
Min length: 1
Max length: 255
SDK attribute: patchTag

patchURL string required  
Discussion

URL to retrieve the patch bundle for this particular patch.


Charateristics

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