Overview  Diagram  Inheritance  Events  Faults  FSMs  Properties Summary  Properties Detail 

Class hcloud:ASecurityGroup (ABSTRACT)

Class ID:14965
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, tenant-security]
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 Security Group class containing properties that are shared between hcloudSecurityGroup and hcloudExtSecurityGroup objects.

Naming Rules 


DN FORMAT:


Diagram

Super Mo: hcloud:AResource,
Sub Mos: hcloud:ExtSecurityGroup, hcloud:SecurityGroup,
Relations To: cloud:EpP,
Relations: hcloud:RsSecurityGroup,


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: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


Events


Faults


Fsms


Properties Summary
Defined in: hcloud:ASecurityGroup
string:Basic description  (hcloud:ASecurityGroup:description)
           The description of this configuration item.
reference:BinRef epgDn  (hcloud:ASecurityGroup:epgDn)
           The fully qualified name of the endpoint group.
scalar:Bool skipEPAttach  (hcloud:ASecurityGroup:skipEPAttach)
           NO COMMENTS
string:Basic tags  (hcloud:ASecurityGroup:tags)
           [Deprecated] Not used any longer.
hcloud:SecurityGroupType
          scalar:Enum32 		type  (hcloud:ASecurityGroup:type)
           The specific type of the object or component.
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


description

Type: string:Basic

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The description of this configuration item.


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.


epgDn

Type: reference:BinRef

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The fully qualified name of the endpoint group.


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.


skipEPAttach

Type: scalar:Bool

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
NO COMMENTS
Constants
no false --- NO COMMENTS
yes true --- NO COMMENTS
DEFAULT no(false) --- 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.





tags

Type: string:Basic

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
[Deprecated] Not used any longer.


type

Type: hcloud:SecurityGroupType
Primitive Type: scalar:Enum32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The specific type of the object or component.
Constants
default-ep 0u Default Security Group for EPs Default for EPs
default-csr 1u Default Security Group for CSR Default for CSR
non-default 2u Non default security group Non default
DEFAULT non-default(2u) Non default security group Non default






Overview  Diagram  Inheritance  Events  Faults  FSMs  Properties Summary  Properties Detail