Class hcloud:AResource (ABSTRACT)

Class ID:14877
Class Label: AResource
Encrypted: false - 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: None
Semantic Scope Evaluation Rule: Subclasses
Monitoring Policy Source: Parent
Monitoring Flags : [ IsObservable: false, HasStats: false, HasFaults: false, HasHealth: false, HasEventRules: false ]

Abstract class that adds reference DNs towards resolved and logical objects.

Naming Rules


DN FORMAT: 

                


Diagram

Super Mo: hcloud:ACloudBase,
Sub Mos: hcloud:ACidr, hcloud:ACtx, hcloud:ACtxPeer, hcloud:AFilter, hcloud:AFlowLogPol, hcloud:AInstance, hcloud:ALogGrpPol, hcloud:ANlbStats, hcloud:ARouteTableEntry, hcloud:ASecurityGroup, hcloud:ASgRule, hcloud:ATaggableResource, hcloud:Account, hcloud:CertStore, hcloud:Certificate, hcloud:Cgw, hcloud:CloudTrail, hcloud:CloudWatchRule, hcloud:ClusterInfo, hcloud:ConfigRecorder, hcloud:DiagnosticSetting, hcloud:EPSelectorInfo, hcloud:EPSelectorSubnet, hcloud:EPSelectorSubnetData, hcloud:EndpointData, hcloud:ExtEPSelectorData, hcloud:FilterEntryData, hcloud:GarbageCollector, hcloud:HubCtx, hcloud:Igw, hcloud:InfraRes, hcloud:Listener, hcloud:ListenerRule, hcloud:MsgQ, hcloud:Prov, hcloud:ProvAccount, hcloud:ProvAcctGC, hcloud:ProvMaxEpSecGrp, hcloud:Racl, hcloud:RaclRule, hcloud:Region, hcloud:RegionLimit, hcloud:ResourceMap, hcloud:RouteTable, hcloud:RsRFltAttData, hcloud:ScaleSet, hcloud:SelectedEP, hcloud:StorageBucket, hcloud:Subnet, hcloud:TargetCtxPeer, hcloud:TargetGroup, hcloud:ToEPgData, hcloud:Topic, hcloud:TopicRes, hcloud:Vgw, hcloud:VrfGroup, hinventory:AAInventory,


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:ACidr 
 
 
 
 
 ├
[V] hcloud:Cidr 
 
 
 
 ├
[V] hcloud:ACtx 
 
 
 
 
 ├
[V] hcloud:Ctx 
 
 
 
 ├
[V] hcloud:ACtxPeer 
 
 
 
 
 ├
[V] hcloud:CtxPeer 
 
 
 
 
 ├
[V] hcloud:InterHubCtxPeer 
 
 
 
 ├
[V] hcloud:AFilter 
 
 
 
 
 ├
[V] hcloud:StatsFilter 
 
 
 
 ├
[V] hcloud:AFlowLogPol 
 
 
 
 
 ├
[V] hcloud:SubnetFlowLogPol 
 
 
 
 
 ├
[V] hcloud:VpcFlowLogPol 
 
 
 
 ├
[V] hcloud:AInstance 
 
 
 
 
 ├
[V] hcloud:AHostRouter 
 
 
 
 
 
 ├
[V] hcloud:Csr 
 
 
 
 
 ├
[V] hcloud:Instance 
 
 
 
 ├
[V] hcloud:ALogGrpPol 
 
 
 
 
 ├
[V] hcloud:LogGrpPol 
 
 
 
 ├
[V] hcloud:ANlbStats 
 
 
 
 
 ├
[V] hcloud:NlbStats 
 
 
 
 ├
[V] hcloud:ARouteTableEntry 
 
 
 
 
 ├
[V] hcloud:ContractRTEntry 
 
 
 
 
 ├
[V] hcloud:InfraVrfGroupRTEntry 
 
 
 
 
 ├
[V] hcloud:RouteTableEntry 
 
 
 
 ├
[V] hcloud:ASecurityGroup  Abstract Security Group class containing properties that are shared between hcloudSecurityGroup and hcloudExtSecurityGroup objects.
 
 
 
 
 ├
[V] hcloud:ExtSecurityGroup  Placeholder that indicate a external connection
 
 
 
 
 ├
[V] hcloud:SecurityGroup  Group of endpoint sharing the same security rules
 
 
 
 ├
[V] hcloud:ASgRule  Abstract Security Group Rule class containing properties that are shared between all types of rules.
 
 
 
 
 ├
[V] hcloud:IpEgressRule  Security Group egress rule that specifies destination IP subnet address.
 
 
 
 
 ├
[V] hcloud:IpIngressRule  Security Group ingress rule that specifies source IP subnet address.
 
 
 
 
 ├
[V] hcloud:SgEgressRule  Security Group egress rule that specifies destination Security Group's DN.
 
 
 
 
 ├
[V] hcloud:SgIngressRule  Security Group ingress rule that specifies source Security Group's DN.
 
 
 
 ├
[V] hcloud:ATaggableResource  Abstract class for any cloud-related class that can be tagged and grouped using tag selector framework.
 
 
 
 
 ├
[V] hcloud:AEndPoint 
 
 
 
 
 
 ├
[V] hcloud:EndPoint 
 
 
 
 
 
 ├
[V] hcloud:NetworkInterface 
 
 
 
 
 
 ├
[V] hcloud:ScaleSetNicGroup 
 
 
 
 ├
[V] hcloud:Account  Represents a cloud tenant, i.e. both owner and container of cloud resources. It maps 1:1 to fvTenant. Which means that for each fvTenant an hcloudAccount must be created. Depending on the cloud provider it implies different things, as detailed as follows. AWS: hcloudAccount stores cloud account's credentials or just the accoun...
 
 
 
 ├
[V] hcloud:CertStore 
 
 
 
 ├
[V] hcloud:Certificate 
 
 
 
 ├
[V] hcloud:Cgw 
 
 
 
 ├
[V] hcloud:CloudTrail  Cloud provider service to capture configuration change requests
 
 
 
 ├
[V] hcloud:CloudWatchRule  Rules to filter out the events to watch and monitor
 
 
 
 ├
[V] hcloud:ClusterInfo 
 
 
 
 ├
[V] hcloud:ConfigRecorder  A config recorder captures configuration changes to a specified set of resources
 
 
 
 ├
[V] hcloud:DiagnosticSetting 
 
 
 
 ├
[V] hcloud:EPSelectorInfo 
 
 
 
 ├
[V] hcloud:EPSelectorSubnet 
 
 
 
 ├
[V] hcloud:EPSelectorSubnetData 
 
 
 
 ├
[V] hcloud:EndpointData 
 
 
 
 ├
[V] hcloud:ExtEPSelectorData 
 
 
 
 ├
[V] hcloud:FilterEntryData 
 
 
 
 ├
[V] hcloud:GarbageCollector  GarbageCollector is deprecated
 
 
 
 ├
[V] hcloud:HubCtx 
 
 
 
 ├
[V] hcloud:Igw 
 
 
 
 ├
[V] hcloud:InfraRes  This object contains the hierarcy of the infrastructure resources that the cloud provider offers. Examples are message queues, storage services etc
 
 
 
 ├
[V] hcloud:Listener 
 
 
 
 ├
[V] hcloud:ListenerRule 
 
 
 
 ├
[V] hcloud:MsgQ  Message queue services offered by the provider
 
 
 
 ├
[V] hcloud:Prov  MOs Cloud Provider
 
 
 
 ├
[V] hcloud:ProvAccount  Cloud Provider Account
 
 
 
 ├
[V] hcloud:ProvAcctGC  Provider Account resource policy for garbage collection
 
 
 
 ├
[V] hcloud:ProvMaxEpSecGrp  Provider resource policy to limit SG per Endpoint
 
 
 
 ├
[V] hcloud:Racl 
 
 
 
 ├
[V] hcloud:RaclRule 
 
 
 
 ├
[V] hcloud:Region  Represents a cloud region managed by CAPIC. Cloud resources will not be deployed in unmanaged regions.
 
 
 
 ├
[V] hcloud:RegionLimit 
 
 
 
 ├
[V] hcloud:ResourceMap  TODO: remove once stimulus.go is fixed
 
 
 
 ├
[V] hcloud:RouteTable 
 
 
 
 ├
[V] hcloud:RsRFltAttData 
 
 
 
 ├
[V] hcloud:ScaleSet 
 
 
 
 ├
[V] hcloud:SelectedEP 
 
 
 
 ├
[V] hcloud:StorageBucket  Cloud provider top level storage unit
 
 
 
 ├
[V] hcloud:Subnet 
 
 
 
 ├
[V] hcloud:TargetCtxPeer 
 
 
 
 ├
[V] hcloud:TargetGroup 
 
 
 
 ├
[V] hcloud:ToEPgData 
 
 
 
 ├
[V] hcloud:Topic  Topic is the container for the notifications from various resources in the pub sub model
 
 
 
 ├
[V] hcloud:TopicRes 
 
 
 
 ├
[V] hcloud:Vgw 
 
 
 
 ├
[V] hcloud:VrfGroup 
 
 
 
 ├
[V] hinventory:AAInventory  Objects section
 
 
 
 
 ├
[V] hinventory:AInventory 
 
 
 
 
 
 ├
[V] hinventory:ARouteTable 
 
 
 
 
 
 
 ├
[V] hinventory:RouteTable 
 
 
 
 
 
 
 ├
[V] hinventory:TgwRouteTable 
 
 
 
 
 
 ├
[V] hinventory:ARouteTableEntry 
 
 
 
 
 
 
 ├
[V] hinventory:RouteTableEntry 
 
 
 
 
 
 
 ├
[V] hinventory:TgwRouteTableEntry 
 
 
 
 
 
 ├
[V] hinventory:Account 
 
 
 
 
 
 ├
[V] hinventory:ApplicationSecurityGroup 
 
 
 
 
 
 ├
[V] hinventory:AvailZone 
 
 
 
 
 
 ├
[V] hinventory:AzurePublicIP 
 
 
 
 
 
 ├
[V] hinventory:ComputeInstance 
 
 
 
 
 
 ├
[V] hinventory:ComputeInstanceScaleSet 
 
 
 
 
 
 ├
[V] hinventory:Ctx 
 
 
 
 
 
 ├
[V] hinventory:CtxCidr 
 
 
 
 
 
 ├
[V] hinventory:CustomerGateway 
 
 
 
 
 
 ├
[V] hinventory:EgressRule 
 
 
 
 
 
 ├
[V] hinventory:IngressRule 
 
 
 
 
 
 ├
[V] hinventory:InternetGateway 
 
 
 
 
 
 ├
[V] hinventory:Inventory 
 
 
 
 
 
 ├
[V] hinventory:Listener 
 
 
 
 
 
 ├
[V] hinventory:LoadBalancer 
 
 
 
 
 
 ├
[V] hinventory:NetworkInterface 
 
 
 
 
 
 ├
[V] hinventory:PrivateIP 
 
 
 
 
 
 ├
[V] hinventory:Provider 
 
 
 
 
 
 ├
[V] hinventory:PublicIP 
 
 
 
 
 
 ├
[V] hinventory:Region 
 
 
 
 
 
 ├
[V] hinventory:ResourceGrp 
 
 
 
 
 
 ├
[V] hinventory:ResourceShare 
 
 
 
 
 
 ├
[V] hinventory:ResourceShareInvitation 
 
 
 
 
 
 ├
[V] hinventory:SecurityGroup 
 
 
 
 
 
 ├
[V] hinventory:SqlDb 
 
 
 
 
 
 ├
[V] hinventory:SqlServer 
 
 
 
 
 
 ├
[V] hinventory:StorageAcct 
 
 
 
 
 
 ├
[V] hinventory:Subnet 
 
 
 
 
 
 ├
[V] hinventory:Tag 
 
 
 
 
 
 ├
[V] hinventory:TargetGroup 
 
 
 
 
 
 ├
[V] hinventory:TransitGateway 
 
 
 
 
 
 ├
[V] hinventory:TransitGatewayAttachment 
 
 
 
 
 
 ├
[V] hinventory:VpcFlowLog 
 
 
 
 
 
 ├
[V] hinventory:VpnConnection 
 
 
 
 
 
 ├
[V] hinventory:VpnGateway 
 
 
 
 
 ├
[V] hinventory:GCTimer  Timer MO for triggering Garbage Collector's Sweep workflow periodically
 
 
 
 
 ├
[V] hinventory:StaleCont  Container of all StaleResource objects
 
 
 
 
 ├
[V] hinventory:StaleResource  StaleResource represents a single cloud resource classified as stale


Events
                


Faults
                


Fsms
                


Properties Summary
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



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.