PolicyGroup

Policy groups are collections of VPorts that are used as building blocks for security policies encompassing multiple end-points. One or more vports can be added to a policy group using this interface.

Overview

assocPolicyGroupCategoryID string
assocPolicyGroupCategoryName string read only  
creationDate string read only   autogenerated   orderable  
description string
embeddedMetadata list read only   autogenerated  
entityScope enum (ENTERPRISE | GLOBAL) autogenerated  
entityState enum (MARKED_FOR_DELETION | UNDER_CONSTRUCTION)
EVPNCommunityTag string filterable   orderable  
external boolean filterable  
externalID string filterable   orderable   locally unique  
lastUpdatedBy string autogenerated  
lastUpdatedDate string read only   autogenerated   orderable  
name string required   filterable   orderable  
owner string autogenerated  
policyGroupID integer filterable  
templateID string
type enum (HARDWARE | SOFTWARE) required   filterable  

API Resource

/policygroups/id
delete get put

Parents

/containerinterfaces/id/policygroups
get
/policygroups
get
/vports/id/policygroups
get put
/policygroupcategories/id/policygroups
get
/vminterfaces/id/policygroups
get
/domains/id/policygroups
get post
/bridgeinterfaces/id/policygroups
get
/l2domains/id/policygroups
get post
/hostinterfaces/id/policygroups
get
/aggregateddomains/id/policygroups
get post

Children

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

Members

/policygroups/id/policygroupcategories
get
/policygroups/id/vports
get put

Attributes documentation

assocPolicyGroupCategoryID string
Discussion

UUID of the associated Policy Group Category for contextual filtering of policy groups.

Charateristics

Format: free
SDK attribute: assocPolicyGroupCategoryID

assocPolicyGroupCategoryName string read only  
Discussion

Name of the Policy Group Category used for contextual filtering of policy groups.

Charateristics

Format: free
SDK attribute: assocPolicyGroupCategoryName

creationDate string read only   autogenerated   orderable  
Discussion

Time stamp when this object was created.

Charateristics

SDK attribute: creationDate

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

entityState enum
Discussion

Intermediate State of L2 Domain.

Charateristics

Allowed values: MARKED_FOR_DELETION, UNDER_CONSTRUCTION
SDK attribute: entityState

EVPNCommunityTag string filterable   orderable  
Discussion

Assigned by VSD. 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
Min length: 1
Max length: 255
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

lastUpdatedDate string read only   autogenerated   orderable  
Discussion

Time stamp when this object was last updated.

Charateristics

SDK attribute: lastUpdatedDate

name string required   filterable   orderable  
Discussion

Name of the policy 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

policyGroupID integer filterable  
Discussion

PG ID for the subnet. This is unique per domain and will be in the range 1-4095

Charateristics

SDK attribute: policyGroupID

templateID string
Discussion

Determines which template ID this policy group belongs to.

Charateristics

Format: free
SDK attribute: templateID

type enum required   filterable  
Discussion

Type of policy group.

Charateristics

Allowed values: HARDWARE, SOFTWARE
SDK attribute: type