Overview  Diagram  Inheritance  Events  Faults  FSMs  Properties Summary  Properties Detail 

Class hcloud:AHostRouter (ABSTRACT)

Class ID:14905
Class Label: Abstract Host Router
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, tenant-connectivity, tenant-ext-connectivity]
Creatable/Deletable: derived (see Container Mos for details)
Semantic Scope: None
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: hcloud:AInstance,
Sub Mos: hcloud:Csr,
Contained Mos: hcloud:DiskOper, hcloud:InstanceOper,


Inheritance
[V] naming:NamedObject An abstract base class for an object that contains a name.
 ├
 		[V] pol:Obj Represents a generic policy object.
 
 		 ├
 		[V] hcloud:ACloudBase  Abstract class for any cloud-related class. If you are planning to define a class for an actual cloud resource, then you must inherit from hcloud:AResource abstract class instead.
 
 		 
 		 ├
 		[V] hcloud:AResource  Abstract class that adds reference DNs towards resolved and logical objects.
 
 		 
 		 
 		 ├
 		[V] hcloud:AInstance 
 
 		 
 		 
 		 
 		 ├
 		[V] hcloud:AHostRouter 
 
 		 
 		 
 		 
 		 
 		 ├
 		[V] hcloud:Csr 


Events


Faults


Fsms


Properties Summary
Defined in: hcloud:AHostRouter
string:Password password  (hcloud:AHostRouter:password)
           The administrative password.
hcloud:HostRouterThroughputType
          scalar:Enum32 		throughput  (hcloud:AHostRouter:throughput)
           NO COMMENTS
string:Basic username  (hcloud:AHostRouter:username)
           NO COMMENTS
Defined in: hcloud:AResource
reference:BinRef delegateDn  (hcloud:AResource:delegateDn)
           DN of logical object to which delegate possible faults
reference:BinRef resolvedObjDn  (hcloud:AResource:resolvedObjDn)
           DN of resolved object that generated this concrete (hcloud) object
Defined in: hcloud:ACloudBase
naming:Name
          string:Basic 		name  (hcloud:ACloudBase:name)
           Overrides:pol:Obj:name | naming:NamedObject:name
           The name of the object.
naming:NameAlias
          string:Basic 		nameAlias  (hcloud:ACloudBase:nameAlias)
           Overrides: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




delegateDn

Type: reference:BinRef

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
DN of logical object to which delegate possible faults


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:pol:Obj:name  |  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

Overrides:naming:NamedObject:nameAlias

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


password

Type: string:Password

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


resolvedObjDn

Type: reference:BinRef

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
DN of resolved object that generated this concrete (hcloud) 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.





throughput

Type: hcloud:HostRouterThroughputType
Primitive Type: scalar:Enum32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
NO COMMENTS
Constants
10G 10000u 10GB Throughput NO COMMENTS
1G 1000u 1GB Throughput NO COMMENTS
100M 100u 100MB Throughput NO COMMENTS
10M 10u 10MB Throughput NO COMMENTS
2.5G 2500u 2.5GB Throughput NO COMMENTS
250M 250u 250MB Throughput NO COMMENTS
5G 5000u 5GB Throughput NO COMMENTS
500M 500u 500MB Throughput NO COMMENTS
50M 50u 50MB Throughput NO COMMENTS
7.5G 7500u 7.5GB Throughput NO COMMENTS
DEFAULT 10M(10u) 10MB Throughput NO COMMENTS




username

Type: string:Basic

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




Overview  Diagram  Inheritance  Events  Faults  FSMs  Properties Summary  Properties Detail