Class fabric:ProtGEp (ABSTRACT)

Class ID:980
Class Label: Group Endpoint
Encrypted: false - Exportable: false - Persistent: true - Configurable: false - Subject to Quota: Disabled
Write Access: [NON CONFIGURABLE]
Read Access: [access-connectivity-l1, access-connectivity-l3, admin, fabric-connectivity-l1, fabric-connectivity-l3, tenant-connectivity-l3, tenant-ext-connectivity-l3]
Creatable/Deletable: no (see Container Mos for details)
Semantic Scope: Fabric
Semantic Scope Evaluation Rule: Subclasses
Monitoring Policy Source: Parent
Monitoring Flags : [ IsObservable: true, HasStats: false, HasFaults: true, HasHealth: true, HasEventRules: false ]

A VPC protection group.

Naming Rules


DN FORMAT: 

[1] uni/fabric/protpol/

                


Diagram

Super Mo: fabric:AProtGEp,
Sub Mos: fabric:AutoGEp, fabric:ExplicitGEp,
Container Mos: fabric:ProtPol (deletable:no),
Contained Mos: fabric:LagId, fabric:NodePEp,
Relations From: ip:Nexthop, infra:NodeCfg, fabric:NodeCfg, l3:LbRtdIf, infra:NodeCfgCont,
Relations To: vpc:InstPol,
Relations: fabric:RsVpcInstPol, fabric:RtNexthopToProtG, fabric:RtProtGroup, fabric:RtProtGrp, fabric:RtProtLbIf, fabric:RtProtectionGrp,


Inheritance
[V] nw:Item Ignore.
 ├
[V] nw:Conn A connection abstraction.
 
 ├
[V] nw:GEp A group endpoint abstraction.
 
 
 ├
[V] fabric:ConnGEp A connectivity group.
 
 
 
 ├
[V] fabric:NodeGEp A node connectivity group.
 
 
 
 
 ├
[V] fabric:AProtGEp An abstraction of the VPC protection group.
 
 
 
 
 
 ├
[V] fabric:ProtGEp A VPC protection group.
 
 
 
 
 
 
 ├
[V] fabric:AutoGEp A VPC auto-protection group. This represents a VPC domain (a protection group). You can set the type of algorithm to be used for creating the automatic groups. Based on the algorithm, APIC implicitly makes discovered nodes part of the group.
 
 
 
 
 
 
 ├
[V] fabric:ExplicitGEp A VPC explicit protection group represents a VPC domain (a protection group). You can explicitly configure member nodes of the group using a Fabric policy node endpoint.


Events
                


Faults
                fabric:ProtGEp:configurationFailed
fabric:ProtGEp:operStateChange
fabric:ProtGEp:operStateFail
fabric:ProtGEp:zoneconfiguration


Fsms
                


Properties Summary
Defined in: fabric:ProtGEp
fabric:ConfigQual
          scalar:Bitmask64
configQual  (fabric:ProtGEp:configQual)
           null
fabric:ConfigSt
          scalar:Enum8
configSt  (fabric:ProtGEp:configSt)
           null
naming:Name
          string:Basic
name  (fabric:ProtGEp:name)
           Overrides:nw:Conn:name
           The name of the object.
Defined in: fabric:AProtGEp
fabric:PairId
          scalar:Uint16
id  (fabric:AProtGEp:id)
           Logical Pair Id
address:Ip virtualIp  (fabric:AProtGEp:virtualIp)
           The virtual IP address. This address is assigned to the GUI.
Defined in: mo:TopProps
mo:ModificationChildAction
          scalar:Bitmask32
childAction  (mo:TopProps:childAction)
           Delete or ignore. For internal use only.
reference:BinRef dn  (mo:TopProps:dn)
           A tag or metadata is a non-hierarchical keyword or term assigned to the fabric module.
reference:BinRN rn  (mo:TopProps:rn)
           Identifies an object from its siblings within the context of its parent object. The distinguished name contains a sequence of relative names.
mo:ModificationStatus
          scalar:Bitmask32
status  (mo:TopProps:status)
           The upgrade status. This property is for internal use only.
Properties Detail

childAction

Type: mo:ModificationChildAction
Primitive Type: scalar:Bitmask32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelChildAction
    Comments:
Delete or ignore. For internal use only.
Constants
deleteAll 16384u deleteAll NO COMMENTS
ignore 4096u ignore NO COMMENTS
deleteNonPresent 8192u deleteNonPresent NO COMMENTS
DEFAULT 0 --- This type is used to





configQual

Type: fabric:ConfigQual
Primitive Type: scalar:Bitmask64

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
null
Constants
none 0x0ull none NO COMMENTS
pairs-not-same-zone 0x100ull Nodes are not part of same zone configuration NO COMMENTS
node-is-not-leaf 0x10ull One Node in VPC is Not Leaf NO COMMENTS
one-node-not-ready 0x1ull One Node in VPC Not in Fabric NO COMMENTS
pairs-not-same-pod 0x200ull Nodes are not part of same POD NO COMMENTS
virtual-ip-not-allocated 0x20ull Virtual IP Not Allocated NO COMMENTS
both-nodes-not-ready 0x2ull Both Nodes in VPC Not in Fabric NO COMMENTS
logical-pair-id-not-allocated 0x40ull Logical Pair ID Not Allocated NO COMMENTS
node-ip-address-unknown 0x4ull VPC Node IP Address Unknown NO COMMENTS
policy-deployment-failed 0x80ull VPC Deployment Failed NO COMMENTS
node-part-multiple-vpc 0x8ull One Node in VPC Already Member of Other VPC NO COMMENTS
DEFAULT none(0x0ull) none NO COMMENTS





configSt

Type: fabric:ConfigSt
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
null
Constants
none 0 none NO COMMENTS
not-deployed 1 not-deployed NO COMMENTS
deployed 2 deployed NO COMMENTS
DEFAULT none(0) none NO COMMENTS





dn

Type: reference:BinRef

Units: null
Encrypted: false
Access: implicit
Category: TopLevelDn
    Comments:
A tag or metadata is a non-hierarchical keyword or term assigned to the fabric module.



id

Type: fabric:PairId
Primitive Type: scalar:Uint16

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
    Comments:
Logical Pair Id



name

Type: naming:Name
Primitive Type: string:Basic

Overrides:nw:Conn:name
Units: null Encrypted: false Access: admin Category: TopLevelRegular
    Comments:
The name of the object.



rn

Type: reference:BinRN

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRn
    Comments:
Identifies an object from its siblings within the context of its parent object. The distinguished name contains a sequence of relative names.



status

Type: mo:ModificationStatus
Primitive Type: scalar:Bitmask32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelStatus
    Comments:
The upgrade status. This property is for internal use only.
Constants
created 2u created In a setter method: specifies that an object should be created. An error is returned if the object already exists.
In the return value of a setter method: indicates that an object has been created.
modified 4u modified In a setter method: specifies that an object should be modified
In the return value of a setter method: indicates that an object has been modified.
deleted 8u deleted In a setter method: specifies that an object should be deleted.
In the return value of a setter method: indicates that an object has been deleted.
DEFAULT 0 --- This type controls the life cycle of objects passed in the XML API.

When used in a setter method (such as configConfMo), the ModificationStatus specifies whether an object should be created, modified, deleted or removed.
In the return value of a setter method, the ModificationStatus indicates the actual operation that was performed. For example, the ModificationStatus is set to "created" if the object was created. The ModificationStatus is not set if the object was neither created, modified, deleted or removed.

When invoking a setter method, the ModificationStatus is optional:
If a setter method such as configConfMo is invoked and the ModificationStatus is not set, the system automatically determines if the object should be created or modified.






virtualIp

Type: address:Ip

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The virtual IP address. This address is assigned to the GUI.