Class hvs:ExtPol (CONCRETE)

Class ID:105
Class Label: Portgroup
Encrypted: false - Exportable: false - Persistent: true - Configurable: false - Subject to Quota: Disabled
Write Access: [NON CONFIGURABLE]
Read Access: [admin, vmm-connectivity, vmm-ep]
Creatable/Deletable: yes (see Container Mos for details)
Semantic Scope: Infra
Semantic Scope Evaluation Rule: Parent
Monitoring Policy Source: Parent
Monitoring Flags : [ IsObservable: true, HasStats: false, HasFaults: true, HasHealth: true, HasEventRules: false ]

The extended policies, which are common policies for VM interfaces. For example, when implementing VMware, this represents the distributed virtual port group.

Naming Rules
RN FORMAT: extpol-{oid}

    [1] PREFIX=extpol- PROPERTY = oid




DN FORMAT: 

[0] comp/prov-{name}/ctrlr-{[domName]}-{name}/sw-{oid}/extpol-{oid}

                


Diagram

Super Mo: fabric:Def,
Container Mos: hvs:LNode (deletable:yes),
Contained Mos: comp:EpPConn, comp:PrimaryEncapDef, fvns:EncapBlkDef, hvs:Encap, hvs:ResCont, res:Consumer,
Relations From: comp:VNic, comp:MgmtNic, comp:HpNic,
Relations To: comp:EpPD, hvs:PvlanEntry,
Relations: hvs:RsEpPD, hvs:RsExtPol, hvs:RsPvlan, hvs:RsPvlan2, hvs:RtDlPol, hvs:RtExtPol, hvs:RtMgmtPol, hvs:RtUlPol,


Containers Hierarchies
[V] top:Root  This class represents the root element in the object hierarchy. All managed objects in the system are descendants of the Root element.
 ├
[V] comp:Uni The top level class for all compute related objects.
 
 ├
[V] comp:Prov The VM provider inventory is the inventory of a VM provider such as VMware or Microsoft. The VM provider profile policies determine the VM inventory that is collected.
 
 
 ├
[V] comp:Ctrlr The operational state of the VM management system controller such as a VMware vCenter, VMware vShield, or Microsoft SCVMM.
 
 
 
 ├
[V] hvs:LNode The logical node, which represents a virtual switch across hypervisors. For example, when implementing VMWare, this object represents VMware vSphere Distributed Switch (VDS ).
 
 
 
 
 ├
[V] hvs:ExtPol The extended policies, which are common policies for VM interfaces. For example, when implementing VMware, this represents the distributed virtual port group.


Contained Hierarchy
[V] hvs:ExtPol The extended policies, which are common policies for VM interfaces. For example, when implementing VMware, this represents the distributed virtual port group.
 ├
[V] comp:EpPConn An object representing the connection information of a VM endpoint. This is used internally by the system.
 
 ├
[V] fault:Counts An immutable object that provides the number of critical, major, minor, and warning faults raised on its parent object and its subtree.
 
 ├
[V] fault:Inst Contains detailed information of a fault. This object is attached as a child of the object on which the fault condition occurred. One instance object is created for each fault condition of the parent object. A fault instance object is identified by a fault code.
 
 ├
[V] health:Inst A base class for a health score instance.(Switch only)
 ├
[V] comp:PrimaryEncapDef 
 
 ├
[V] comp:EpPConn An object representing the connection information of a VM endpoint. This is used internally by the system.
 
 
 ├
[V] fault:Counts An immutable object that provides the number of critical, major, minor, and warning faults raised on its parent object and its subtree.
 
 
 ├
[V] fault:Inst Contains detailed information of a fault. This object is attached as a child of the object on which the fault condition occurred. One instance object is created for each fault condition of the parent object. A fault instance object is identified by a fault code.
 
 
 ├
[V] health:Inst A base class for a health score instance.(Switch only)
 
 ├
[V] fault:Counts An immutable object that provides the number of critical, major, minor, and warning faults raised on its parent object and its subtree.
 
 ├
[V] fault:Delegate Exposes internal faults to the user. A fault delegate object can be defined on IFC (for example, for an endpoint group) and when the fault is raised (for example, under an endpoint policy on a switch), a fault delegate object is created on IFC under the specified object. A fault delegate object follows the lifecycle of the original fault instance object, being created, modified, or deleted based on the changes of the original fault.
 
 ├
[V] health:Inst A base class for a health score instance.(Switch only)
 ├
[V] fault:Counts An immutable object that provides the number of critical, major, minor, and warning faults raised on its parent object and its subtree.
 ├
[V] fault:Delegate Exposes internal faults to the user. A fault delegate object can be defined on IFC (for example, for an endpoint group) and when the fault is raised (for example, under an endpoint policy on a switch), a fault delegate object is created on IFC under the specified object. A fault delegate object follows the lifecycle of the original fault instance object, being created, modified, or deleted based on the changes of the original fault.
 ├
[V] fault:Inst Contains detailed information of a fault. This object is attached as a child of the object on which the fault condition occurred. One instance object is created for each fault condition of the parent object. A fault instance object is identified by a fault code.
 ├
[V] fvns:EncapBlkDef The encapsulation block definition.
 
 ├
[V] fault:Delegate Exposes internal faults to the user. A fault delegate object can be defined on IFC (for example, for an endpoint group) and when the fault is raised (for example, under an endpoint policy on a switch), a fault delegate object is created on IFC under the specified object. A fault delegate object follows the lifecycle of the original fault instance object, being created, modified, or deleted based on the changes of the original fault.
 ├
[V] health:Inst A base class for a health score instance.(Switch only)
 ├
[V] hvs:Encap Contains the encap and multicast address of the ExtPol. If this child encap exists, the ExtPol uses this encap or the encap properties of the ExtPol.
 
 ├
[V] fault:Delegate Exposes internal faults to the user. A fault delegate object can be defined on IFC (for example, for an endpoint group) and when the fault is raised (for example, under an endpoint policy on a switch), a fault delegate object is created on IFC under the specified object. A fault delegate object follows the lifecycle of the original fault instance object, being created, modified, or deleted based on the changes of the original fault.
 ├
[V] hvs:ResCont 
 
 ├
[V] fault:Counts An immutable object that provides the number of critical, major, minor, and warning faults raised on its parent object and its subtree.
 
 ├
[V] health:Inst A base class for a health score instance.(Switch only)
 
 ├
[V] res:Consumer This is generated and used only by internal processes.
 
 
 ├
[V] fault:Counts An immutable object that provides the number of critical, major, minor, and warning faults raised on its parent object and its subtree.
 
 
 ├
[V] fault:Inst Contains detailed information of a fault. This object is attached as a child of the object on which the fault condition occurred. One instance object is created for each fault condition of the parent object. A fault instance object is identified by a fault code.
 
 
 ├
[V] health:Inst A base class for a health score instance.(Switch only)
 ├
[V] hvs:RsEpPD A source relation to the abstraction for the endpoint group policy description.
 ├
[V] hvs:RsExtPol A source relation to the common policies for the interfaces on VMs.
 ├
[V] hvs:RsPvlan 
 ├
[V] hvs:RsPvlan2 
 ├
[V] hvs:RtDlPol A target relation to the extended policies for the interfaces on VMs.
 ├
[V] hvs:RtExtPol A target relation to the extended policies for the interfaces on VMs.
 ├
[V] hvs:RtMgmtPol A target relation to the extended policies for the interfaces on VMs.
 ├
[V] hvs:RtUlPol A target relation to the extended policies for the interfaces on VMs.
 ├
[V] res:Consumer This is generated and used only by internal processes.
 
 ├
[V] fault:Counts An immutable object that provides the number of critical, major, minor, and warning faults raised on its parent object and its subtree.
 
 ├
[V] fault:Inst Contains detailed information of a fault. This object is attached as a child of the object on which the fault condition occurred. One instance object is created for each fault condition of the parent object. A fault instance object is identified by a fault code.
 
 ├
[V] health:Inst A base class for a health score instance.(Switch only)


Inheritance
[V] naming:NamedObject An abstract base class for an object that contains a name.
 ├
[V] pol:Obj Represents a generic policy object.
 
 ├
[V] pol:Def Represents self-contained policy document.
 
 
 ├
[V] fabric:Def A base class for fabric policies.
 
 
 
 ├
[V] hvs:ExtPol The extended policies, which are common policies for VM interfaces. For example, when implementing VMware, this represents the distributed virtual port group.


Events
                


Faults
                hvs:ExtPol:operIssues


Fsms
                


Properties Summary
Defined in: hvs:ExtPol
vmm:StatusInVmm
          scalar:Bitmask8
OperSt  (hvs:ExtPol:OperSt)
           null
comp:SecBool
          scalar:Enum8
allowPromiscuous  (hvs:ExtPol:allowPromiscuous)
           Security Policy Parameters
comp:ConfigMode
          scalar:Enum8
blockAllPorts  (hvs:ExtPol:blockAllPorts)
           NO COMMENTS
comp:EncapMode
          scalar:Enum8
encapMode  (hvs:ExtPol:encapMode)
           NO COMMENTS
base:Encap endEncap  (hvs:ExtPol:endEncap)
           The last IP address of the VLAN encapsulation block.
comp:EpPDType
          scalar:Enum8
eppdType  (hvs:ExtPol:eppdType)
           Indicates type of extpol whether is being used for tenant or management purposes
comp:SecBool
          scalar:Enum8
forgedTransmits  (hvs:ExtPol:forgedTransmits)
           NO COMMENTS
comp:Guid
          string:Basic
guid  (hvs:ExtPol:guid)
           null
comp:SecBool
          scalar:Enum8
macChanges  (hvs:ExtPol:macChanges)
           NO COMMENTS
address:Ip mcastAddr  (hvs:ExtPol:mcastAddr)
           null
vmm:Mode
          scalar:Enum8
mode  (hvs:ExtPol:mode)
           mode of operation
reference:BinRef monPolDn  (hvs:ExtPol:monPolDn)
          
naming:Name
          string:Basic
name  (hvs:ExtPol:name)
           Overrides:pol:Obj:name | naming:NamedObject:name
           The name for the policies.
fv:NetflowPref
          scalar:Enum8
netflowPref  (hvs:ExtPol:netflowPref)
           NO COMMENTS
comp:Oid
          string:Basic
oid  (hvs:ExtPol:oid)
           null
hvs:OperIssues
          scalar:Bitmask64
operIssues  (hvs:ExtPol:operIssues)
          
vmm:OwnershipType
          scalar:Enum8
ownership  (hvs:ExtPol:ownership)
          
comp:Oid
          string:Basic
pgKey  (hvs:ExtPol:pgKey)
           NO COMMENTS
base:Encap primaryEncap  (hvs:ExtPol:primaryEncap)
           NO COMMENTS
base:Encap startEncap  (hvs:ExtPol:startEncap)
           The first IP address in the VLAN encapsulation block.
hvs:ExtPolT
          scalar:Enum8
type  (hvs:ExtPol:type)
           The type for the policies.
Defined in: pol:Def
naming:Descr
          string:Basic
descr  (pol:Def:descr)
           Specifies a description of the policy definition.
naming:Descr
          string:Basic
ownerKey  (pol:Def:ownerKey)
           The key for enabling clients to own their data for entity correlation.
naming:Descr
          string:Basic
ownerTag  (pol:Def:ownerTag)
           A tag for enabling clients to add their own data. For example, to indicate who created this object.
Defined in: naming:NamedObject
naming:NameAlias
          string:Basic
nameAlias  (naming:NamedObject:nameAlias)
           NO COMMENTS
Defined in: mo:Resolvable
mo:Owner
          scalar:Enum8
lcOwn  (mo:Resolvable:lcOwn)
           A value that indicates how this object was created. For internal use only.
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.
Defined in: mo:Modifiable
mo:TStamp
          scalar:Date
modTs  (mo:Modifiable:modTs)
           The time when this object was last modified.
Properties Detail

OperSt

Type: vmm:StatusInVmm
Primitive Type: scalar:Bitmask8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
null
Constants
unknown 0 Unknown NO COMMENTS
pendingApply 1 pendingAdd NO COMMENTS
pendingDelete 2 pendingDelete NO COMMENTS
applied 4 applied NO COMMENTS
DEFAULT unknown(0) Unknown NO COMMENTS





allowPromiscuous

Type: comp:SecBool
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Security Policy Parameters
Constants
reject 0 Reject NO COMMENTS
accept 1 Accept NO COMMENTS
DEFAULT reject(0) Reject NO COMMENTS





blockAllPorts

Type: comp:ConfigMode
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
NO COMMENTS
Constants
Disabled 1 Disabled NO COMMENTS
Enabled 2 Enabled NO COMMENTS
DEFAULT Disabled(1) Disabled NO COMMENTS





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





descr

Type: naming:Descr
Primitive Type: string:Basic

Like: naming:Described:descr
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
    Comments:
Specifies a description of the policy definition.



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.



encapMode

Type: comp:EncapMode
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
NO COMMENTS
Constants
access 0 Access Mode NO COMMENTS
trunk 1 Trunk Mode NO COMMENTS
private 2 Private Mode NO COMMENTS
DEFAULT access(0) Access Mode NO COMMENTS





endEncap

Type: base:Encap

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The last IP address of the VLAN encapsulation block.



eppdType

Type: comp:EpPDType
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Indicates type of extpol whether is being used for tenant or management purposes
Constants
Mgmt 1 Mgmt NO COMMENTS
Tenant 2 Tenant NO COMMENTS
Services 3 Services NO COMMENTS
DEFAULT Tenant(2) Tenant NO COMMENTS





forgedTransmits

Type: comp:SecBool
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
NO COMMENTS
Constants
reject 0 Reject NO COMMENTS
accept 1 Accept NO COMMENTS
DEFAULT reject(0) Reject NO COMMENTS





guid

Type: comp:Guid
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
null



lcOwn

Type: mo:Owner
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
A value that indicates how this object was created. For internal use only.
Constants
local 0 Local NO COMMENTS
policy 1 Policy NO COMMENTS
replica 2 Replica NO COMMENTS
resolveOnBehalf 3 ResolvedOnBehalf NO COMMENTS
implicit 4 Implicit NO COMMENTS
DEFAULT local(0) Local NO COMMENTS





macChanges

Type: comp:SecBool
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
NO COMMENTS
Constants
reject 0 Reject NO COMMENTS
accept 1 Accept NO COMMENTS
DEFAULT reject(0) Reject NO COMMENTS





mcastAddr

Type: address:Ip

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
null



modTs

Type: mo:TStamp
Primitive Type: scalar:Date

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The time when this object was last modified.
Constants
never 0ull never NO COMMENTS
DEFAULT never(0ull) never NO COMMENTS





mode

Type: vmm:Mode
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
mode of operation
Constants
default 0 Distributed Switch NO COMMENTS
n1kv 1 Cisco AVS NO COMMENTS
unknown 2 Unknown NO COMMENTS
ovs 3 Open vSwitch NO COMMENTS
DEFAULT default(0) Distributed Switch NO COMMENTS





monPolDn

Type: reference:BinRef

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:



name

Type: naming:Name
Primitive Type: string:Basic

Overrides:pol:Obj:name  |  naming:NamedObject:name
Units: null Encrypted: false Access: implicit Category: TopLevelRegular
    Comments:
The name for the policies.



nameAlias

Type: naming:NameAlias
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
    Comments:
NO COMMENTS



netflowPref

Type: fv:NetflowPref
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
NO COMMENTS
Constants
disabled 1 disabled NO COMMENTS
enabled 2 enabled NO COMMENTS
DEFAULT disabled(1) disabled NO COMMENTS





oid

Type: comp:Oid
Primitive Type: string:Basic

Units: null
Encrypted: false
Naming Property -- [NAMING RULES]
Access: naming
Category: TopLevelRegular
    Comments:
null



operIssues

Type: hvs:OperIssues
Primitive Type: scalar:Bitmask64

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Constants
none 0x0ull None NO COMMENTS
invalid-extpol 0x1ull Cannot find an EPG policy in the domain for the portgroup. NO COMMENTS
invalid-secgrp 0x2ull EPG policy and security group mismatch. NO COMMENTS
DEFAULT none(0x0ull) None NO COMMENTS





ownerKey

Type: naming:Descr
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
    Comments:
The key for enabling clients to own their data for entity correlation.



ownerTag

Type: naming:Descr
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
    Comments:
A tag for enabling clients to add their own data. For example, to indicate who created this object.



ownership

Type: vmm:OwnershipType
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Constants
local 1 local NO COMMENTS
remote 2 remote NO COMMENTS
DEFAULT local(1) local NO COMMENTS





pgKey

Type: comp:Oid
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
NO COMMENTS



primaryEncap

Type: base:Encap

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
NO COMMENTS



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.



startEncap

Type: base:Encap

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The first IP address in the VLAN encapsulation block.



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.






type

Type: hvs:ExtPolT
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The type for the policies.
Constants
vnic 1 vnic NO COMMENTS
pnic 2 pnic NO COMMENTS
vsmgmt 3 vsmgmt NO COMMENTS
DEFAULT vnic(1) vnic NO COMMENTS