PolicyGroupTemplate

PolicyGroupTemplate represents the template of a policy group object. PolicyGroup is group of vports on which a user can policies like ACL, QoS, etc.

Overview

description string
embeddedMetadata list read only   autogenerated  
entityScope enum (ENTERPRISE | GLOBAL) autogenerated  
EVPNCommunityTag string
external boolean filterable  
externalID string filterable   orderable   locally unique  
lastUpdatedBy string autogenerated  
name string required   filterable   orderable  
type enum (HARDWARE | SOFTWARE) required   filterable  

API Resource

/policygrouptemplates/id
delete get put

Parents

/l2domaintemplates/id/policygrouptemplates
get post
/domaintemplates/id/policygrouptemplates
get post

Children

/policygrouptemplates/id/permissions
delete get post put
/policygrouptemplates/id/metadatas
get post
/policygrouptemplates/id/globalmetadatas
get post put
/policygrouptemplates/id/eventlogs
get

Members

This object has no members.

Attributes documentation

description string
Discussion

Describes this policy 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

EVPNCommunityTag string
Discussion

An extended community or other similar BGP attribute to the specific EVPN / IP-VPN NLRI where the VM or network macro is being advertised.

Charateristics

Format: free
SDK attribute: EVPNCommunityTag

external boolean filterable  
Discussion

Indicates whether this PG is internal to VSP or not.

Charateristics

SDK attribute: external

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   filterable   orderable  
Discussion

Name of the policy group

Charateristics

Format: free
SDK attribute: name

type enum required   filterable  
Discussion

Type of policy group.

Charateristics

Allowed values: HARDWARE, SOFTWARE
SDK attribute: type