Class hcloud:ASgRule (ABSTRACT)

Class ID:15506
Class Label: asgrule
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 Security Group Rule class containing properties that are shared between all types of rules.

Naming Rules


DN FORMAT: 

                


Diagram

Super Mo: hcloud:AResource,
Sub Mos: hcloud:IpEgressRule, hcloud:IpIngressRule, hcloud:SgEgressRule, hcloud:SgIngressRule,
Contained Mos: hcloud:EPSelectorSubnetData, hcloud:EndpointData, hcloud:ExtEPSelectorData, hcloud:FilterEntryData, hcloud:RsRFltAttData,


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


Events
                


Faults
                


Fsms
                


Properties Summary
Defined in: hcloud:ASgRule
reference:BinRef contractDn  (hcloud:ASgRule:contractDn)
           DN of vzBrCP logical object (contract) to display in rule's description
string:Basic description  (hcloud:ASgRule:description)
           The description of this configuration item.
l4:Port
          scalar:Uint16
fromPort  (hcloud:ASgRule:fromPort)
           The port block from port.
icmp:Code
          scalar:Uint16
icmpCode  (hcloud:ASgRule:icmpCode)
           The ICMP code.
icmpv4:Type
          scalar:UByte
icmpv4Type  (hcloud:ASgRule:icmpv4Type)
           ICMP version 4 type number.
icmpv6:Type
          scalar:UByte
icmpv6Type  (hcloud:ASgRule:icmpv6Type)
           ICMP version 6 type number.
scalar:Bool isEPSelectorSubnetDnSet  (hcloud:ASgRule:isEPSelectorSubnetDnSet)
           NO COMMENTS
scalar:Bool isExtEPSelectorDnSet  (hcloud:ASgRule:isExtEPSelectorDnSet)
           NO COMMENTS
l3:IpProt
          scalar:UByte
protocol  (hcloud:ASgRule:protocol)
           The transfer protocol to be used for data export.
l4:Port
          scalar:Uint16
toPort  (hcloud:ASgRule:toPort)
           The fabric card's port.
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





contractDn

Type: reference:BinRef

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
DN of vzBrCP logical object (contract) to display in rule's description



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.



fromPort

Type: l4:Port
Primitive Type: scalar:Uint16

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The port block from port.
Constants
unspecified 0 Unspecified NO COMMENTS
ftpData 20 FTP data NO COMMENTS
smtp 25 SMTP NO COMMENTS
dns 53 DNS NO COMMENTS
http 80 HTTP NO COMMENTS
pop3 110 POP3 NO COMMENTS
https 443 HTTPS NO COMMENTS
rtsp 554 RTSP NO COMMENTS
DEFAULT unspecified(0) Unspecified NO COMMENTS





icmpCode

Type: icmp:Code
Primitive Type: scalar:Uint16

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The ICMP code.
Constants
unspecified 0xffff Unspecified NO COMMENTS
defaultValue 0 --- NO COMMENTS





icmpv4Type

Type: icmpv4:Type
Primitive Type: scalar:UByte

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
ICMP version 4 type number.
Constants
echo-rep 0 Echo Reply Echo Reply
dst-unreach 3 Destination Unreachable Destination Unreachable
src-quench 4 Source Quench Source Quench
echo 8 Echo Echo
time-exceeded 11 Time Exceeded Time Exceeded
unspecified 255 Unspecified Unspecified
DEFAULT unspecified(255) Unspecified Unspecified





icmpv6Type

Type: icmpv6:Type
Primitive Type: scalar:UByte

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
ICMP version 6 type number.
Constants
unspecified 0 Unspecified Unspecified
dst-unreach 1 Destination Unreachable Destination Unreachable
time-exceeded 3 Time Exceeded Time Exceeded
echo-req 128 Echo Request Echo Request
echo-rep 129 Echo Reply Echo Reply
nbr-solicit 135 Neighbor Solicitation Neighbor Solicitation
nbr-advert 136 Neighbor Advertisement Neighbor Advertisement
redirect 137 Redirect Message Redirect Message
DEFAULT unspecified(0) Unspecified Unspecified





isEPSelectorSubnetDnSet

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





isExtEPSelectorDnSet

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





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



protocol

Type: l3:IpProt
Primitive Type: scalar:UByte

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The transfer protocol to be used for data export.
Constants
unspecified 0 Unspecified Unspecified
icmp 1 icmp NO COMMENTS
igmp 2 igmp NO COMMENTS
tcp 6 tcp NO COMMENTS
egp 8 egp NO COMMENTS
igp 9 igp NO COMMENTS
udp 17 udp NO COMMENTS
icmpv6 58 icmpv6 NO COMMENTS
eigrp 88 eigrp NO COMMENTS
ospfigp 89 ospf NO COMMENTS
pim 103 pim NO COMMENTS
l2tp 115 l2tp NO COMMENTS
DEFAULT unspecified(0) Unspecified Unspecified





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.






toPort

Type: l4:Port
Primitive Type: scalar:Uint16

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The fabric card's port.
Constants
unspecified 0 Unspecified NO COMMENTS
ftpData 20 FTP data NO COMMENTS
smtp 25 SMTP NO COMMENTS
dns 53 DNS NO COMMENTS
http 80 HTTP NO COMMENTS
pop3 110 POP3 NO COMMENTS
https 443 HTTPS NO COMMENTS
rtsp 554 RTSP NO COMMENTS
DEFAULT unspecified(0) Unspecified NO COMMENTS