Class hcloud:EndPointOper (CONCRETE)

Class ID:14954
Encrypted: false - Exportable: false - Persistent: false - Configurable: false - Subject to Quota: Disabled - Abstraction Layer: Resolved Model - APIC NX Processing: Disabled
Write Access: [NON CONFIGURABLE]
Read Access: [admin, tenant-connectivity, tenant-ext-connectivity]
Creatable/Deletable: yes (see Container Mos for details)
Semantic Scope: None
Semantic Scope Evaluation Rule: Parent
Monitoring Policy Source: Parent
Monitoring Flags : [ IsObservable: true, HasStats: false, HasFaults: true, HasHealth: true, HasEventRules: false ]

NO COMMENTS

Naming Rules
RN FORMAT: epoper

    [1] PREFIX=epoper


DN FORMAT: 

[0] cprov-{vendor}/provacc-{[name]}/acct-{[name]}/region-{[regionName]}/context-{[name]}-addr-{[primaryCidr]}/cidr-{[addr]}/subnet-{[addr]}/ssnicgroup-{[name]}/epoper

[1] acct-{[name]}/region-{[regionName]}/context-{[name]}-addr-{[primaryCidr]}/cidr-{[addr]}/subnet-{[addr]}/ssnicgroup-{[name]}/epoper

[2] failedoperholder/failedoper-{[configDn]}/epoper

[3] genericsstore/rule-{name}/ruleinstance-{[key]}/rulesubject-{[subjectKey]}/epoper

[4] cprov-{vendor}/provacc-{[name]}/acct-{[name]}/region-{[regionName]}/context-{[name]}-addr-{[primaryCidr]}/csr-{[name]}/nwif-{deviceIndex}/epoper

[5] acct-{[name]}/region-{[regionName]}/context-{[name]}-addr-{[primaryCidr]}/csr-{[name]}/nwif-{deviceIndex}/epoper

[6] genericsstore/rule-{name}/ruleinstance-{[key]}/rulesubject-{[subjectKey]}/ep-{[name]}/epoper

[7] cprov-{vendor}/provacc-{[name]}/acct-{[name]}/region-{[regionName]}/context-{[name]}-addr-{[primaryCidr]}/cidr-{[addr]}/subnet-{[addr]}/ep-{[name]}/epoper

[8] acct-{[name]}/region-{[regionName]}/context-{[name]}-addr-{[primaryCidr]}/cidr-{[addr]}/subnet-{[addr]}/ep-{[name]}/epoper

[9] cprov-{vendor}/provacc-{[name]}/acct-{[name]}/region-{[regionName]}/context-{[name]}-addr-{[primaryCidr]}/ep-{[name]}/epoper

[10] acct-{[name]}/region-{[regionName]}/context-{[name]}-addr-{[primaryCidr]}/ep-{[name]}/epoper

                


Diagram

Super Mo: hcloud:Oper,
Container Mos: generics:RuleSubject (deletable:yes), hcloud:AEndPoint (deletable:yes), hcloud:FailedOper (deletable:yes),
Contained Mos: hcloud:IpV4Addr,


Containers Hierarchies
[V] top:Root  This class represents the root element in the object hierarchy. All managed objects in the system are descendants of the Root element.
 ├
[V] hcloud:Prov  MOs Cloud Provider
 
 ├
[V] hcloud:ProvAccount  Cloud Provider Account
 
 
 ├
[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:Region  Represents a cloud region managed by CAPIC. Cloud resources will not be deployed in unmanaged regions.
 
 
 
 
 ├
[V] hcloud:Ctx 
 
 
 
 
 
 ├
[V] hcloud:Cidr 
 
 
 
 
 
 
 ├
[V] hcloud:Subnet 
 
 
 
 
 
 
 
 ├
[V] hcloud:ScaleSetNicGroup 
 
 
 
 
 
 
 
 
 ├
[V] hcloud:EndPointOper 
[V] top:Root  This class represents the root element in the object hierarchy. All managed objects in the system are descendants of the Root element.
 ├
[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:Region  Represents a cloud region managed by CAPIC. Cloud resources will not be deployed in unmanaged regions.
 
 
 ├
[V] hcloud:Ctx 
 
 
 
 ├
[V] hcloud:Cidr 
 
 
 
 
 ├
[V] hcloud:Subnet 
 
 
 
 
 
 ├
[V] hcloud:ScaleSetNicGroup 
 
 
 
 
 
 
 ├
[V] hcloud:EndPointOper 
[V] top:Root  This class represents the root element in the object hierarchy. All managed objects in the system are descendants of the Root element.
 ├
[V] hcloud:FailedOperHolder  Singleton object that serves as root of subtree containing orphan operational objects. Specifically, this subtree contains operational objects reporting failures.
 
 ├
[V] hcloud:FailedOper 
 
 
 ├
[V] hcloud:EndPointOper 
[V] top:Root  This class represents the root element in the object hierarchy. All managed objects in the system are descendants of the Root element.
 ├
[V] generics:Store  Store represents the container for storing all the conditions matched by the generic rules
 
 ├
[V] generics:RuleDef  RuleDef is an internal representation of Rule
 
 
 ├
[V] generics:RuleInst  RuleInst represents a satisfied instance of a rule
 
 
 
 ├
[V] generics:RuleSubject 
 
 
 
 
 ├
[V] hcloud:EndPointOper 
[V] top:Root  This class represents the root element in the object hierarchy. All managed objects in the system are descendants of the Root element.
 ├
[V] hcloud:Prov  MOs Cloud Provider
 
 ├
[V] hcloud:ProvAccount  Cloud Provider Account
 
 
 ├
[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:Region  Represents a cloud region managed by CAPIC. Cloud resources will not be deployed in unmanaged regions.
 
 
 
 
 ├
[V] hcloud:Ctx 
 
 
 
 
 
 ├
[V] hcloud:Csr 
 
 
 
 
 
 
 ├
[V] hcloud:NetworkInterface 
 
 
 
 
 
 
 
 ├
[V] hcloud:EndPointOper 
[V] top:Root  This class represents the root element in the object hierarchy. All managed objects in the system are descendants of the Root element.
 ├
[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:Region  Represents a cloud region managed by CAPIC. Cloud resources will not be deployed in unmanaged regions.
 
 
 ├
[V] hcloud:Ctx 
 
 
 
 ├
[V] hcloud:Csr 
 
 
 
 
 ├
[V] hcloud:NetworkInterface 
 
 
 
 
 
 ├
[V] hcloud:EndPointOper 
[V] top:Root  This class represents the root element in the object hierarchy. All managed objects in the system are descendants of the Root element.
 ├
[V] generics:Store  Store represents the container for storing all the conditions matched by the generic rules
 
 ├
[V] generics:RuleDef  RuleDef is an internal representation of Rule
 
 
 ├
[V] generics:RuleInst  RuleInst represents a satisfied instance of a rule
 
 
 
 ├
[V] generics:RuleSubject 
 
 
 
 
 ├
[V] hcloud:EndPoint 
 
 
 
 
 
 ├
[V] hcloud:EndPointOper 
[V] top:Root  This class represents the root element in the object hierarchy. All managed objects in the system are descendants of the Root element.
 ├
[V] hcloud:Prov  MOs Cloud Provider
 
 ├
[V] hcloud:ProvAccount  Cloud Provider Account
 
 
 ├
[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:Region  Represents a cloud region managed by CAPIC. Cloud resources will not be deployed in unmanaged regions.
 
 
 
 
 ├
[V] hcloud:Ctx 
 
 
 
 
 
 ├
[V] hcloud:Cidr 
 
 
 
 
 
 
 ├
[V] hcloud:Subnet 
 
 
 
 
 
 
 
 ├
[V] hcloud:EndPoint 
 
 
 
 
 
 
 
 
 ├
[V] hcloud:EndPointOper 
[V] top:Root  This class represents the root element in the object hierarchy. All managed objects in the system are descendants of the Root element.
 ├
[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:Region  Represents a cloud region managed by CAPIC. Cloud resources will not be deployed in unmanaged regions.
 
 
 ├
[V] hcloud:Ctx 
 
 
 
 ├
[V] hcloud:Cidr 
 
 
 
 
 ├
[V] hcloud:Subnet 
 
 
 
 
 
 ├
[V] hcloud:EndPoint 
 
 
 
 
 
 
 ├
[V] hcloud:EndPointOper 
[V] top:Root  This class represents the root element in the object hierarchy. All managed objects in the system are descendants of the Root element.
 ├
[V] hcloud:Prov  MOs Cloud Provider
 
 ├
[V] hcloud:ProvAccount  Cloud Provider Account
 
 
 ├
[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:Region  Represents a cloud region managed by CAPIC. Cloud resources will not be deployed in unmanaged regions.
 
 
 
 
 ├
[V] hcloud:Ctx 
 
 
 
 
 
 ├
[V] hcloud:EndPoint 
 
 
 
 
 
 
 ├
[V] hcloud:EndPointOper 
[V] top:Root  This class represents the root element in the object hierarchy. All managed objects in the system are descendants of the Root element.
 ├
[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:Region  Represents a cloud region managed by CAPIC. Cloud resources will not be deployed in unmanaged regions.
 
 
 ├
[V] hcloud:Ctx 
 
 
 
 ├
[V] hcloud:EndPoint 
 
 
 
 
 ├
[V] hcloud:EndPointOper 


Contained Hierarchy
[V] hcloud:EndPointOper 
 ├
[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:Delegate Exposes internal faults to the user. A fault delegate object can be defined on IFC (for example, for an endpoint group) and when the fault is raised (for example, under an endpoint policy on a switch), a fault delegate object is created on IFC under the specified object. A fault delegate object follows the lifecycle of the original fault instance object, being created, modified, or deleted based on the changes of the original fault.
 ├
[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] aaa:RbacAnnotation  RbacAnnotation is used for capturing rbac properties of any apic object Objects can append rbacannotations as Object->RbacAnnotation which is then checked for domain eligibility
 
 ├
[V] tag:Annotation 
 
 ├
[V] tag:Tag 
 ├
[V] hcloud:IpV4Addr 
 
 ├
[V] aaa:RbacAnnotation  RbacAnnotation is used for capturing rbac properties of any apic object Objects can append rbacannotations as Object->RbacAnnotation which is then checked for domain eligibility
 
 ├
[V] tag:Annotation 
 
 ├
[V] tag:Tag 
 ├
[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] 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:Oper  Super class for every Oper MO
 
 
 
 ├
[V] hcloud:EndPointOper 


Events
                


Faults
                hcloud:EndPointOper:CloudEndPointOperStateDown


Fsms
                


Properties Summary
Defined in: hcloud:EndPointOper
hcloud:OperState
          scalar:Enum8
addrOperState  (hcloud:EndPointOper:addrOperState)
           NO COMMENTS
string:Basic attachmentId  (hcloud:EndPointOper:attachmentId)
           NO COMMENTS
string:Basic eIpAllocationId  (hcloud:EndPointOper:eIpAllocationId)
           NO COMMENTS
string:Basic elasticIpAssociationId  (hcloud:EndPointOper:elasticIpAssociationId)
           NO COMMENTS
hcloud:EpType
          scalar:Enum32
epType  (hcloud:EndPointOper:epType)
           NO COMMENTS
address:Ip privateIpv4Addr  (hcloud:EndPointOper:privateIpv4Addr)
           NO COMMENTS
address:Ip privateIpv6Addr  (hcloud:EndPointOper:privateIpv6Addr)
           NO COMMENTS
address:Ip publicIpv4Addr  (hcloud:EndPointOper:publicIpv4Addr)
           NO COMMENTS
address:Ip publicIpv6Addr  (hcloud:EndPointOper:publicIpv6Addr)
           NO COMMENTS
Defined in: hcloud:Oper
string:Basic cloudProviderId  (hcloud:Oper:cloudProviderId)
           NO COMMENTS
reference:BinRef delegateDn  (hcloud:Oper:delegateDn)
           NO COMMENTS
hcloud:OperState
          scalar:Enum8
operState  (hcloud:Oper:operState)
           The operational state of a process.
string:Basic stateReason  (hcloud:Oper:stateReason)
           NO COMMENTS
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: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.
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

addrOperState

Type: hcloud:OperState
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
NO COMMENTS
Constants
pending 0 pending NO COMMENTS
running 1 running NO COMMENTS
shutting-down 2 shutting-down NO COMMENTS
terminated 3 terminated NO COMMENTS
stopping 4 stopping NO COMMENTS
stopped 5 stopped NO COMMENTS
configured 6 configured NO COMMENTS
failed 7 failed NO COMMENTS
available 8 available NO COMMENTS
in-use 9 in-use NO COMMENTS
rebooting 10 rebooting NO COMMENTS
down 11 down NO COMMENTS
requested 12 requested NO COMMENTS
pending-accept 13 pending-accept NO COMMENTS
DEFAULT pending(0) pending NO COMMENTS





attachmentId

Type: string:Basic

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
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





cloudProviderId

Type: string:Basic

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



delegateDn

Type: reference:BinRef

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
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.



eIpAllocationId

Type: string:Basic

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



elasticIpAssociationId

Type: string:Basic

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



epType

Type: hcloud:EpType
Primitive Type: scalar:Enum32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
NO COMMENTS
Constants
ec2Inst 0u Network interface that is attached to a customer EC2 instance NIC that is attached to an EC2 instance
csr 1u Network Interface that is attached to a CSR NIC that is attached to a CSR
awsAlb 2u Network Interface that is attached to an AWS ALB An AWS ALB
vm 3u Network Interface that is attached to an Azure VM NIC that is attached to Azure VM
scaleset-vm 4u Network Interface that is attached to an Azure ScaleSet VM NIC that is attached to Azure ScaleSet VM
container 5u Network interface that is attached to a container running on a cloud platform NIC that is attached to a container
tgw-attachment 6u Transit gateway network interface NO COMMENTS
DEFAULT ec2Inst(0u) Network interface that is attached to a customer EC2 instance NIC that is attached to an EC2 instance





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





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



operState

Type: hcloud:OperState
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The operational state of a process.
Constants
pending 0 pending NO COMMENTS
running 1 running NO COMMENTS
shutting-down 2 shutting-down NO COMMENTS
terminated 3 terminated NO COMMENTS
stopping 4 stopping NO COMMENTS
stopped 5 stopped NO COMMENTS
configured 6 configured NO COMMENTS
failed 7 failed NO COMMENTS
available 8 available NO COMMENTS
in-use 9 in-use NO COMMENTS
rebooting 10 rebooting NO COMMENTS
down 11 down NO COMMENTS
requested 12 requested NO COMMENTS
pending-accept 13 pending-accept NO COMMENTS
DEFAULT pending(0) pending NO COMMENTS





privateIpv4Addr

Type: address:Ip

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



privateIpv6Addr

Type: address:Ip

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



publicIpv4Addr

Type: address:Ip

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



publicIpv6Addr

Type: address:Ip

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    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.



stateReason

Type: string:Basic

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



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.