Overview  Diagram  Inheritance  Events  Faults  FSMs  Properties Summary  Properties Detail 

Class edm:AMgr (ABSTRACT)

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

NO COMMENTS

Naming Rules 


DN FORMAT:


Diagram

Super Mo: edm:Entity,
Sub Mos: edm:Mgr,


Inheritance
[V] naming:NamedObject An abstract base class for an object that contains a name.
 ├
 		[V] naming:NamedIdentifiedObject An abstract base class for an object that contains a name and ID.
 
 		 ├
 		[V] edm:Entity 
 
 		 
 		 ├
 		[V] edm:AMgr 
 
 		 
 		 
 		 ├
 		[V] edm:Mgr  This profile corresponds to External Manager, i.e. UCSM, supporting the JSON/REST Schema fore external Devices


Events


Faults


Fsms


Properties Summary
Defined in: edm:AMgr
edm:Capabilities
          scalar:Bitmask32 		capabilities  (edm:AMgr:capabilities)
           Used to fault a Dev Manager in case intended type doesn't match polled type
string:Basic connURI  (edm:AMgr:connURI)
           Controller name, ip and port info
string:Basic customErrMsg  (edm:AMgr:customErrMsg)
           Used to determine read/write mode to External Device
string:Basic deviceAddress  (edm:AMgr:deviceAddress)
           External Device IP/FQDN Address
extdev:TrigSt
          scalar:Enum8 		inventoryTrigSt  (edm:AMgr:inventoryTrigSt)
           Manual Trigger state of Inventory Sync
scalar:Bool isAppManaged  (edm:AMgr:isAppManaged)
           AppCenter Managed Translator
edm:InventorySt
          scalar:Enum8 		lastInventorySt  (edm:AMgr:lastInventorySt)
           Last inventory pull status
edm:WorkerQueueSz
          scalar:Uint16 		maxWorkerQSize  (edm:AMgr:maxWorkerQSize)
           Max Doer-to-worker queue size
reference:BinRef mgrPKey  (edm:AMgr:mgrPKey)
           Manager Policy Key
edm:MgrOperMode
          scalar:Enum8 		operMode  (edm:AMgr:operMode)
           The operational port mode.
edm:MgrOperState
          scalar:Enum8 		operSt  (edm:AMgr:operSt)
           The runtime state of the object or policy.
string:Password pwd  (edm:AMgr:pwd)
           The system user password.
edm:Capabilities
          scalar:Bitmask32 		userConfiguredFeature  (edm:AMgr:userConfiguredFeature)
           Used to fault a Dev Manager in case intended type doesn't match polled type
string:Basic usr  (edm:AMgr:usr)
           The user account profile user name.
Defined in: edm:Entity
naming:Descr
          string:Basic 		descr  (edm:Entity:descr)
           The description of this configuration item.
naming:Id
          scalar:Uint64 		id  (edm:Entity:id)
           Overrides:naming:NamedIdentifiedObject:id
           An object identifier.
edm:Issues
          scalar:Bitmask64 		issues  (edm:Entity:issues)
           General Issues It captures various issues happened to the Entity.
naming:Name
          string:Basic 		name  (edm:Entity:name)
           Overrides:naming:NamedObject:name
           The name of the object.
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

capabilities

Type: edm:Capabilities
Primitive Type: scalar:Bitmask32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Used to fault a Dev Manager in case intended type doesn't match polled type
Constants
none 0x0u None NO COMMENTS
switch-manager 0x1u Switch Manager NO COMMENTS
sdwan 0x2u SDWan Controller NO COMMENTS
DEFAULT none(0x0u) None 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




connURI

Type: string:Basic

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Controller name, ip and port info


customErrMsg

Type: string:Basic

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Used to determine read/write mode to External Device


descr

Type: naming:Descr
Primitive Type: string:Basic

Like: naming:Described:descr
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
    Comments:
The description of this configuration item.


deviceAddress

Type: string:Basic

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
    Comments:
External Device IP/FQDN Address


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: naming:Id
Primitive Type: scalar:Uint64

Overrides:naming:NamedIdentifiedObject:id

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
An object identifier.


inventoryTrigSt

Type: extdev:TrigSt
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
    Comments:
Manual Trigger state of Inventory Sync
Constants
triggered 0 triggered NO COMMENTS
untriggered 1 untriggered NO COMMENTS
autoTriggered 2 autoTriggered NO COMMENTS
DEFAULT untriggered(1) untriggered NO COMMENTS




isAppManaged

Type: scalar:Bool

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




issues

Type: edm:Issues
Primitive Type: scalar:Bitmask64

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
General Issues It captures various issues happened to the Entity.
Constants
none 0x0ull None NO COMMENTS
vpn-pull-fault 0x1000ull Error in pulling VPNs from remote vManage Device NO COMMENTS
sla-statspull-fault 0x100ull Error in pulling SLA Stats NO COMMENTS
nicprof-config-fault 0x10ull Error configuring NIC Profiles on Integration Manager NO COMMENTS
connection-fault 0x1ull Failed to connect with Integration Manager NO COMMENTS
sla-dscp-fault 0x2000ull Error in pushing SLA DSCP mapping to remote vManage Device NO COMMENTS
sla-polpull-fault 0x200ull Error in pulling SLA Policies NO COMMENTS
uplinkprof-config-fault 0x20ull Error configuring Uplink Profiles on Integration Manager NO COMMENTS
nicprof-missing-fault 0x2ull Configured NIC Profile does not exist on Integration Manager NO COMMENTS
create-vpn-list-fault 0x4000ull VPN list not configured on remote vManage Device NO COMMENTS
sla-policies-not-configured-fault 0x400ull SLA Policies are not configured on remote vManage Device NO COMMENTS
partner-registration-fault 0x40ull Error registering APIC as partner NO COMMENTS
uplinkprof-missing-fault 0x4ull Configured Uplink Profile does not exist on Integration Manager NO COMMENTS
create-prefix-mapping-fault 0x8000ull Prefix Mapping not configured on remote vManage Device NO COMMENTS
create-prefix-list-fault 0x800ull Prefix list not configured on remote vManage Device NO COMMENTS
sla-config-fault 0x80ull Error in pushing SLA NO COMMENTS
encap-config-fault 0x8ull Error configuring Encaps on Integration Manager NO COMMENTS
DEFAULT none(0x0ull) None NO COMMENTS




lastInventorySt

Type: edm:InventorySt
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Last inventory pull status
Constants
completed 0 Completed NO COMMENTS
partial 1 Partially Completed NO COMMENTS
failed 2 Failed NO COMMENTS
completedex 3 Completed with exception NO COMMENTS
DEFAULT completed(0) Completed NO COMMENTS




maxWorkerQSize

Type: edm:WorkerQueueSz
Primitive Type: scalar:Uint16

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Max Doer-to-worker queue size
Constants
defaultQueueSize 300 Default Worker Queue Size NO COMMENTS
DEFAULT defaultQueueSize(300) Default Worker Queue Size NO COMMENTS




mgrPKey

Type: reference:BinRef

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Manager Policy Key


name

Type: naming:Name
Primitive Type: string:Basic

Overrides:naming:NamedObject:name

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The name of the object.


nameAlias

Type: naming:NameAlias
Primitive Type: string:Basic

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


operMode

Type: edm:MgrOperMode
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The operational port mode.
Constants
read-write 0 Read-Write NO COMMENTS
read-only 1 Read-Only NO COMMENTS
maintenance 2 Maintenance Mode NO COMMENTS
DEFAULT read-write(0) Read-Write NO COMMENTS




operSt

Type: edm:MgrOperState
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The runtime state of the object or policy.
Constants
unknown 0 Unknown NO COMMENTS
online 1 Online NO COMMENTS
offline 2 Offline NO COMMENTS
deallocated 3 Deallocated NO COMMENTS
syncsuccess 4 Sync Successful NO COMMENTS
registered 5 Registration Successful NO COMMENTS
DEFAULT unknown(0) Unknown NO COMMENTS




pwd

Type: string:Password

Units: null
Encrypted: true
Access: implicit
Category: TopLevelRegular
    Comments:
The system user password.


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.





userConfiguredFeature

Type: edm:Capabilities
Primitive Type: scalar:Bitmask32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Used to fault a Dev Manager in case intended type doesn't match polled type
Constants
none 0x0u None NO COMMENTS
switch-manager 0x1u Switch Manager NO COMMENTS
sdwan 0x2u SDWan Controller NO COMMENTS
DEFAULT none(0x0u) None NO COMMENTS




usr

Type: string:Basic

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The user account profile user name.




Overview  Diagram  Inheritance  Events  Faults  FSMs  Properties Summary  Properties Detail