Class fv:OrchsInfo (CONCRETE)

Class ID:5566
Class Label: Orchestrator configuration for this EPG
Encrypted: false - Exportable: true - Persistent: true - Configurable: true - Subject to Quota: Disabled
Write Access: [admin, tenant-epg]
Read Access: [admin, tenant-epg]
Creatable/Deletable: yes (see Container Mos for details)
Possible Semantic Scopes: EPG, Fabric,
Semantic Scope Evaluation Rule: Parent
Monitoring Policy Source: Parent
Monitoring Flags : [ IsObservable: true, HasStats: false, HasFaults: true, HasHealth: true, HasEventRules: false ]

The orchestration information is used to store orchestration specific properties such as Microsoft Azure Pack.

Naming Rules
RN FORMAT: Orchs-{name}

    [1] PREFIX=Orchs- PROPERTY = name




DN FORMAT: 

        Too Many Containers: 61
                


Containers Hierarchies
Too Many containers: 61


Contained Hierarchy
[V] fv:OrchsInfo The orchestration information is used to store orchestration specific properties such as Microsoft Azure Pack.
 ├
[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] fv:OptedPlanSrvc 
 ├
[V] fv:OrchsLBCfg 
 ├
[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] fv:OrchsInfo The orchestration information is used to store orchestration specific properties such as Microsoft Azure Pack.


Events
                fv:OrchsInfo:creation__fv_OrchsInfo
fv:OrchsInfo:modification__fv_OrchsInfo
fv:OrchsInfo:deletion__fv_OrchsInfo


Faults
                fv:OrchsInfo:vipNotAllocated


Fsms
                


Properties Summary
Defined in: fv:OrchsInfo
string:Basic addrNsName  (fv:OrchsInfo:addrNsName)
           null
string:Basic cloud  (fv:OrchsInfo:cloud)
           null
comp:DeployIssues
          scalar:Bitmask64
deployIssues  (fv:OrchsInfo:deployIssues)
           The issues that occurred while deploying an object. For example, this is set when there is a connectivity issues from the APIC to the external VM management system.
reference:BinRef monPolDn  (fv:OrchsInfo:monPolDn)
           The monitoring policy attached to this observable object.
naming:Name
          string:Basic
name  (fv:OrchsInfo:name)
           Overrides:naming:NamedObject:name
           The name of the object.
scalar:Bool needVip  (fv:OrchsInfo:needVip)
           null
string:Basic plan  (fv:OrchsInfo:plan)
           null
string:Basic svcsMode  (fv:OrchsInfo:svcsMode)
           NO COMMENTS
string:Basic usrAcc  (fv:OrchsInfo:usrAcc)
           null
address:Ip vip  (fv:OrchsInfo:vip)
           The Infra Virtual IP of a VPC switch pair.
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.
Defined in: mo:Ownable
scalar:Uint16 uid  (mo:Ownable:uid)
           A unique identifier for this object.
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:Modifiable
mo:TStamp
          scalar:Date
modTs  (mo:Modifiable:modTs)
           The time when this object was last modified.
Properties Detail

addrNsName

Type: string:Basic

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "512"
    Comments:
null



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





cloud

Type: string:Basic

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "512"
    Comments:
null



deployIssues

Type: comp:DeployIssues
Primitive Type: scalar:Bitmask64

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The issues that occurred while deploying an object. For example, this is set when there is a connectivity issues from the APIC to the external VM management system.
Constants
none 0x0ull N/A NO COMMENTS
invalid-vlan-encap 0x1000000000ull VLAN encap mode is not allowed for AVE Non-Local switching domain NO COMMENTS
missing-internal-vlan-pool 0x100000000ull Missing Internal VLAN pools for EPGs in AVE Domain NO COMMENTS
trunk-portgroup-unsupported 0x10000000ull Trunk portgroup not supported NO COMMENTS
epg-pol-enforce-unsupported 0x1000000ull Intra EPG Isolation is not supported in AVS-VLAN mode and AVE-VLAN mode VMM domains NO COMMENTS
epp-mcast-addr-match-fabric 0x100000ull EPG mcast address is the same as fabric mcast address. Domain fabric multicast address overlaps multicast address pool. NO COMMENTS
invalid-mcast-addr 0x10000ull No valid mcast address allocated for the epg NO COMMENTS
dvs-config-failed 0x1000ull Failed to configure DVS. NO COMMENTS
no-ctrlr-dn 0x100ull Controller DN missing. NO COMMENTS
proc-vmm-error 0x10ull Cluster type object missing from controller. NO COMMENTS
invalid-encap 0x1ull No valid encapsulation identifier allocated for the epg NO COMMENTS
internal-vlan-pool-full 0x200000000ull Insufficient VLANs. Internal VLAN pool full for EPGs in AVE Domain NO COMMENTS
resimedcy-unsupported 0x20000000ull resolution immediacy not supported for this domain NO COMMENTS
invalid-usegepg-encap 0x2000000ull primary encap property and encap property both need to be set NO COMMENTS
duplicate-static-encap 0x200000ull Duplicate EPG encapsulation value NO COMMENTS
attr-dom-not-supported 0x20000ull attribute based EPG is not supported for the domain type NO COMMENTS
policy-not-found 0x2000ull Failed to find Policy Container for Controller. NO COMMENTS
dvs-version-error 0x200ull Could not get DVS version. NO COMMENTS
dvs-prep-error 0x20ull DVS preparation error for VXLAN. NO COMMENTS
dvs-error 0x2ull Failed to get DVS config. NO COMMENTS
invalid-encap-mode 0x400000000ull Encap Mode cannot be VXLAN when Switching Mode is native for this VMM Domain NO COMMENTS
invalid-netflow-preference 0x40000000ull Netflow cannot be Enabled for EPG associated to VMM domain in AVS Mode NO COMMENTS
epg-useg-unsupported 0x4000000ull Microsegmentation is not supported for the controller NO COMMENTS
invalid-switching-mode 0x400000ull VMM Domain needs to be of type Cisco AVE for Switching Mode AVE NO COMMENTS
invalid-vip 0x40000ull VIP has not been allocated NO COMMENTS
ctrlr-unsupported 0x4000ull Unsupported Controller. NO COMMENTS
pg-api-error 0x400ull Portgroup property get API failed. NO COMMENTS
unsupported-ctrlr 0x40ull Invalid Controller scope. NO COMMENTS
vdn-error 0x4ull Network scope creation error. NO COMMENTS
epg-pol-enforce-redhat-unsupported 0x800000000ull Intra EPG Isolation is not supported for Redhat domains NO COMMENTS
ipv6-dstaddr-unsupported 0x80000000ull Netflow Exporter DstAddr supports IPv6 from DVS version 6.0 and higher. Please use an IPv4 address for the Netflow Exporter DstAddr NO COMMENTS
invalid-trunk-portgroup-range 0x8000000ull trunk portgroup VLAN ranges are out of domain VLAN pool NO COMMENTS
epg-pol-enforce-missing-pri_encap 0x800000ull Missing primary encap in VMM Domain relation for policy enforced EPG NO COMMENTS
invalid-static-encap 0x80000ull EPG encapsulation value is not part of any static encapsulation block for the VMM domain NO COMMENTS
ctrlr-not-deployable 0x8000ull Controller not deployable. NO COMMENTS
lacp-apply-failed 0x800ull LACP update for Portgroup failed. NO COMMENTS
no-ctrlr-map 0x80ull Controller missing from internal map. NO COMMENTS
prep-vxlan-error 0x8ull VXLAN cluster preparation error. NO COMMENTS
DEFAULT none(0x0ull) N/A 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.



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





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





monPolDn

Type: reference:BinRef

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The monitoring policy attached to this observable object.



name

Type: naming:Name
Primitive Type: string:Basic

Overrides:naming:NamedObject:name
Units: null Encrypted: false Naming Property -- [NAMING RULES] Access: naming Category: TopLevelRegular Property Validators: Range: min: "1" max: "16" Allowed Chars: Regex: [a-zA-Z0-9_.:-]+
    Comments:
The name of the object.



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



needVip

Type: scalar:Bool

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
null
Constants
no false --- NO COMMENTS
yes true --- NO COMMENTS
DEFAULT no(false) --- NO COMMENTS





plan

Type: string:Basic

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "512"
    Comments:
null



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.






svcsMode

Type: string:Basic

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "512"
    Comments:
NO COMMENTS



uid

Type: scalar:Uint16

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
A unique identifier for this object.



usrAcc

Type: string:Basic

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "512"
    Comments:
null



vip

Type: address:Ip

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
The Infra Virtual IP of a VPC switch pair.