PolicyObjectGroup

Policy Object Groups are a collection of existing Network Services Gateways. These groups can be used in routing policies for domain links.

Overview

creationDate string read only   autogenerated   orderable  
description string filterable   orderable  
embeddedMetadata list read only   autogenerated  
entityScope enum (ENTERPRISE | GLOBAL) autogenerated  
externalID string filterable   orderable   locally unique  
lastUpdatedBy string autogenerated  
lastUpdatedDate string read only   autogenerated   orderable  
name string filterable   orderable  
owner string autogenerated  
type enum (Gateway | NSGateway) filterable   orderable  

API Resource

/policyobjectgroups/id
delete get put

Parents

/enterprises/id/policyobjectgroups
get post
/policyobjectgroups
get

Children

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

Members

/policyobjectgroups/id/gateways
get put
/policyobjectgroups/id/nsgateways
get put

Attributes documentation

creationDate string read only   autogenerated   orderable  
Discussion

Time stamp when this object was created.

Charateristics

SDK attribute: creationDate

description string filterable   orderable  
Discussion

Description of the Policy Object Group

Charateristics

Format: free
SDK attribute: description

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

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

name string filterable   orderable  
Discussion

Name of the Policy Object Group

Charateristics

Format: free
SDK attribute: name

owner string autogenerated  
Discussion

Identifies the user that has created this object.

Charateristics

Format: free
SDK attribute: owner

type enum filterable   orderable  
Discussion

Type of the Policy Object Group

Charateristics

Allowed values: Gateway, NSGateway
SDK attribute: type