Class fv:Comp (ABSTRACT)

Class ID:1894
Encrypted: false - Exportable: true - Persistent: true - Configurable: true - Subject to Quota: Disabled - Abstraction Layer: Concrete Model - APIC NX Processing: Disabled
Write Access: []
Read Access: [admin]
Creatable/Deletable: derived (see Container Mos for details)
Possible Semantic Scopes: EPG, Fabric,
Semantic Scope Evaluation Rule: Subclasses
Monitoring Policy Source: Parent
Monitoring Flags : [ IsObservable: false, HasStats: false, HasFaults: false, HasHealth: false, HasEventRules: false ]

An abstraction of the fabric virtualization policy definition.

Naming Rules


DN FORMAT: 

                


Diagram

Super Mo: pol:Comp,
Sub Mos: fv:ATg, vz:Any,


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:Comp Represents a policy component. This object is part of the policy definition.
 
 
 ├
[V] fv:Comp An abstraction of the fabric virtualization policy definition.
 
 
 
 ├
[V] fv:ATg Base class for the Attachable Target Group
 
 
 
 
 ├
[V] fv:CCg A special endpoint group representing a set of connectivity rules to a compute container or hypervisor.
 
 
 
 
 ├
[V] fv:EPg A set of endpoints.
 
 
 
 
 
 ├
[V] cloud:ABaseEPg  Abstract Base Cloud EPg for both Explicit and Implicit cloud EPG's.
 
 
 
 
 
 
 ├
[V] cloud:AAEPg  Abstract Cloud EPg. Named AAEPg in order to avoid confusing this with Application EPg
 
 
 
 
 
 
 
 ├
[V] cloud:EPg  Cloud EPg
 
 
 
 
 
 
 
 ├
[V] cloud:ExtEPg  Cloud External EPg
 
 
 
 
 
 
 ├
[V] cloud:ASvcEPg  Abstract Cloud Service EPg.
 
 
 
 
 
 
 
 ├
[V] cloud:ISvcEPg  Cloud service EPg
 
 
 
 
 
 ├
[V] extnw:EPg An abstraction of a policy controlling connectivity to an external network such as another fabric or WAN.
 
 
 
 
 
 
 ├
[V] l2ext:InstP The external network instance profile represents a group of external subnets that have the same security behavior. These subnets inherit contract profiles applied to the parent instance profile. Each subnet can also associate to route control profiles, which defines the routing behavior for that subnet.
 
 
 
 
 
 
 ├
[V] l3ext:InstP The external network instance profile represents a group of external subnets that have the same security behavior. These subnets inherit contract profiles applied to the parent instance profile. Each subnet can also associate to route control profiles, which defines the routing behavior for that subnet.
 
 
 
 
 
 
 ├
[V] l3ext:InstPDef The L4-L7 services route peering.
 
 
 
 
 
 ├
[V] fv:CEPg A set of hypothetical client endpoints attaching to the network.
 
 
 
 
 
 
 ├
[V] fv:AEPg A set of requirements for the application-level EPG instance. The policy regulates connectivity and visibility among the end points within the scope of the policy.
 
 
 
 
 
 
 ├
[V] fv:TnlEPg  qinq End Point Group
 
 
 
 
 
 
 ├
[V] vns:AEPpInfo 
 
 
 
 
 
 
 
 ├
[V] vns:EPpInfo Internal object to store encap info (vlan ID) for an endpoint.
 
 
 
 
 
 
 
 ├
[V] vns:REPpInfo 
 
 
 
 
 
 
 
 ├
[V] vns:SDEPpInfo 
 
 
 
 
 
 
 
 ├
[V] vns:SHEPpInfo 
 
 
 
 
 
 ├
[V] fv:ESg 
 
 
 
 
 
 ├
[V] infra:EPg Abstraction of an infrastructure endpoint group.
 
 
 
 
 
 
 ├
[V] infra:ACEPg An abstraction of the infrastructure client endpoint group. The client endpoint group represents a set of hypothetical client endpoints attaching to the network.
 
 
 
 
 
 
 
 ├
[V] dhcp:CRelPg A group of DHCP relay function providers: A set of DHCP Server to which client DHCP requests are relayed.
 
 
 
 
 
 
 
 ├
[V] infra:CEPg A base class for the client endpoint group.
 
 
 
 
 
 
 ├
[V] infra:APEPg An abstraction of the infrastructure provider endpoint group. The provider endpoint group represents a set of hypothetical provider endpoints attaching to the network; for example, a set of DHCP servers, fabric relays, or client requests.
 
 
 
 
 
 
 
 ├
[V] dhcp:PRelPg A group of DHCP Relay Function Providers: A set of DHCP Servers to which client DHCP Requests are relayed.
 
 
 
 
 
 
 
 ├
[V] infra:PEPg Ignore, removed
 
 
 
 
 
 ├
[V] mgmt:InB The in-band management endpoint group consists of switches (leaves/spines) and APICs. Each node in the group is assigned an IP address that is dynamically allocated from the address pool associated with the corresponding in-band management zone. The allocated IP address is then configured as the in-band management access IP address on the corresponding node. Any host that is part of another endpoint group can communicate with the nodes in the...
 
 
 
 
 ├
[V] mgmt:InstP The external management entity instance profile communicates with nodes that are part of out-of-band management endpoint group. To enable this communication, a contract is required between the instance profile and the out-of-band management endpoint group.
 
 
 
 
 ├
[V] mgmt:InstPDef The instance profile definition.
 
 
 
 
 ├
[V] mgmt:OoB An out-of-band management endpoint group, which consists of switches (leaves/spines) and APICs that are part of the associated out-of-band management zone. Each node in the group is assigned an IP address that is dynamically allocated from the address pool associated with the corresponding out-of-band management zone. The allocated IP address is then configured on the out-of-band management port of the corresponding node. Hosts that are par...
 
 
 
 ├
[V] vz:Any vzAny associates all endpoint groups (EPGs) in a context (fvCtx) to one or more contracts (vzBrCP), rather than creating a separate contract relation for each EPG. EPGs can only communicate with other EPGs according to contract rules. A relationship between an EPG and a contract specifies whether the EPG provides the communications defined by the contract rules, consumes them, or both. By dynamically applying contract rules to all EPGs in a conte...


Events
                


Faults
                


Fsms
                


Properties Summary
Defined in: pol:Comp
naming:Descr
          string:Basic
descr  (pol:Comp:descr)
           Specifies the description of a policy component.
Defined in: pol:Obj
naming:Name
          string:Basic
name  (pol:Obj:name)
           Overrides:naming:NamedObject:name
           null
Defined in: naming:NamedObject
naming:NameAlias
          string:Basic
nameAlias  (naming:NamedObject:nameAlias)
           NO COMMENTS
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





descr

Type: naming:Descr
Primitive Type: string:Basic

Like: naming:Described:descr
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "128"
        Allowed Chars:
            Regex: [a-zA-Z0-9\\!#$%()*,-./:;@ _{|}~?&+]+
    Comments:
Specifies the description of a policy component.



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.



name

Type: naming:Name
Primitive Type: string:Basic

Overrides:naming:NamedObject:name
Units: null Encrypted: false Access: admin Category: TopLevelRegular Property Validators: Range: min: "0" max: "64" Allowed Chars: Regex: [a-zA-Z0-9_.:-]+
    Comments:
null



nameAlias

Type: naming:NameAlias
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "63"
        Allowed Chars:
            Regex: [a-zA-Z0-9_.-]+
    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.



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.