Class comm:Ssh (CONCRETE)

Class ID:1583
Class Label: Ssh Service
Encrypted: false - Exportable: true - Persistent: true - Configurable: true - Subject to Quota: Disabled - Abstraction Layer: Ambiguous Placement in the Model
Write Access: [aaa, admin]
Read Access: [aaa, admin, fabric-equipment]
Creatable/Deletable: no (see Container Mos for details)
Semantic Scope: Fabric
Semantic Scope Evaluation Rule: Parent
Monitoring Policy Source: Parent
Monitoring Flags : [ IsObservable: false, HasStats: false, HasFaults: false, HasHealth: false, HasEventRules: false ]

Object that encompasses properties related to Secure Shell access to the APIC, namely admin-state (default=enabled) and port(default=22).

Naming Rules
RN FORMAT: ssh

    [1] PREFIX=ssh


DN FORMAT: 

[1] uni/fabric/comm-{name}/ssh

                


Diagram

Super Mo: comm:Shell,
Container Mos: comm:Pol (deletable:no),
Contained Mos: tag:Annotation, tag:Tag,


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] fabric:Topology The root for IFC topology.
 
 ├
[V] fabric:Pod A pod.
 
 
 ├
[V] fabric:Node The root node for the APIC.
 
 
 
 ├
[V] ctx:Local The local Context.
 
 
 
 
 ├
[V] ctx:Application The context application.
 
 
 
 
 
 ├
[V] pol:Uni Represents policy definition/resolution universe.
 
 
 
 
 
 
 ├
[V] fabric:Inst A container object for fabric policies.
 
 
 
 
 
 
 
 ├
[V] comm:Pol The communication policy contains the service configuration for various services.
 
 
 
 
 
 
 
 
 ├
[V] comm:Ssh Object that encompasses properties related to Secure Shell access to the APIC, namely admin-state (default=enabled) and port(default=22).
[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] pol:Uni Represents policy definition/resolution universe.
 
 ├
[V] fabric:Inst A container object for fabric policies.
 
 
 ├
[V] comm:Pol The communication policy contains the service configuration for various services.
 
 
 
 ├
[V] comm:Ssh Object that encompasses properties related to Secure Shell access to the APIC, namely admin-state (default=enabled) and port(default=22).


Contained Hierarchy
[V] comm:Ssh Object that encompasses properties related to Secure Shell access to the APIC, namely admin-state (default=enabled) and port(default=22).
 ├
[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] tag:Annotation 
 ├
[V] tag:Tag 


Inheritance
[V] naming:NamedObject An abstract base class for an object that contains a name.
 ├
[V] pol:Obj Represents a generic policy object.
 
 ├
[V] pol:Comp Represents a policy component. This object is part of the policy definition.
 
 
 ├
[V] comm:Comp default port value is 0. All services that have assigned port override port value. 0 indicates that this service does not use a separate port
 
 
 
 ├
[V] comm:Shell SuperClass for shell-based access (Ssh and Telnet) and not directly used for user configuration.
 
 
 
 
 ├
[V] comm:Ssh Object that encompasses properties related to Secure Shell access to the APIC, namely admin-state (default=enabled) and port(default=22).


Events
                comm:Ssh:creation__comm_Ssh
comm:Ssh:modification__comm_Ssh
comm:Ssh:deletion__comm_Ssh


Faults
                


Fsms
                


Properties Summary
Defined in: comm:Ssh
comm:AdminState
          scalar:Enum8
adminSt  (comm:Ssh:adminSt)
           Overrides:comm:Comp:adminSt
           The state of SSH communication service. This can be enabled or disabled.
mo:Annotation
          string:Basic
annotation  (comm:Ssh:annotation)
           NO COMMENTS
mo:ExtMngdByType
          scalar:Bitmask32
extMngdBy  (comm:Ssh:extMngdBy)
           NO COMMENTS
naming:Name
          string:Basic
name  (comm:Ssh:name)
           Overrides:pol:Obj:name | naming:NamedObject:name
           null
comm:Port
          scalar:Uint32
port  (comm:Ssh:port)
           Overrides:comm:Comp:port
           The SSH port.
comm:SshCipherTypes
          scalar:Bitmask64
sshCiphers  (comm:Ssh:sshCiphers)
           NO COMMENTS
comm:SshMacTypes
          scalar:Bitmask64
sshMacs  (comm:Ssh:sshMacs)
           NO COMMENTS
Defined in: comm:Shell
comm:Protocol
          scalar:Enum8
proto  (comm:Shell:proto)
           Overrides:comm:Comp:proto
           The list of protocols to match.
Defined in: pol:Comp
naming:Descr
          string:Basic
descr  (pol:Comp:descr)
           Specifies the description of a policy component.
Defined in: naming:NamedObject
naming:NameAlias
          string:Basic
nameAlias  (naming:NamedObject:nameAlias)
           NO COMMENTS
Defined in: mo:Modifiable
mo:TStamp
          scalar:Date
modTs  (mo:Modifiable:modTs)
           The time when this object was last modified.
Defined in: mo:Ownable
scalar:Uint16 uid  (mo:Ownable:uid)
           A unique identifier for this object.
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: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

adminSt

Type: comm:AdminState
Primitive Type: scalar:Enum8

Overrides:comm:Comp:adminSt
Units: null Encrypted: false Access: admin Category: TopLevelRegular Property Validators:
    Comments:
The state of SSH communication service. This can be enabled or disabled.
Constants
enabled 1 Enabled NO COMMENTS
disabled 2 Disabled NO COMMENTS
DEFAULT enabled(1) Enabled NO COMMENTS





annotation

Type: mo:Annotation
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "128"
        Allowed Chars:
            Regex: [a-zA-Z0-9_.:-]+
    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





descr

Type: naming:Descr
Primitive Type: string:Basic

Like: naming:Described:descr
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "128"
        Allowed Chars:
            Regex: [a-zA-Z0-9\\!#$%()*,-./:;@ _{|}~?&+]+
    Comments:
Specifies the description of a policy component.



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.



extMngdBy

Type: mo:ExtMngdByType
Primitive Type: scalar:Bitmask32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
NO COMMENTS
Constants
undefined 0u undefined NO COMMENTS
msc 1u msc NO COMMENTS
DEFAULT undefined(0u) undefined NO COMMENTS





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: admin Category: TopLevelRegular Property Validators: Range: min: "0" max: "64" Allowed Chars: Regex: [a-zA-Z0-9_.:-]+
    Comments:
null
Constants
defaultValue "ssh" --- NO COMMENTS





nameAlias

Type: naming:NameAlias
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "63"
        Allowed Chars:
            Regex: [a-zA-Z0-9_.-]+
    Comments:
NO COMMENTS



port

Type: comm:Port
Primitive Type: scalar:Uint32

Overrides:comm:Comp:port
Units: null Encrypted: false Access: admin Category: TopLevelRegular Property Validators: Range: min: (long)0l max: (long)65535l
    Comments:
The SSH port.
Constants
defaultValue 22u --- NO COMMENTS





proto

Type: comm:Protocol
Primitive Type: scalar:Enum8

Overrides:comm:Comp:proto
Units: null Encrypted: false Access: implicit Category: TopLevelRegular
    Comments:
The list of protocols to match.
Constants
none 0 None NO COMMENTS
tcp 1 tcp NO COMMENTS
udp 2 udp NO COMMENTS
all 3 All NO COMMENTS
DEFAULT tcp(1) tcp 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.



sshCiphers

Type: comm:SshCipherTypes
Primitive Type: scalar:Bitmask64

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
NO COMMENTS
Constants
aes128-ctr 1ull aes128-ctr NO COMMENTS
aes192-ctr 2ull aes192-ctr NO COMMENTS
aes256-ctr 4ull aes256-ctr NO COMMENTS
defaultValue (1ull|2ull|4ull) --- NO COMMENTS





sshMacs

Type: comm:SshMacTypes
Primitive Type: scalar:Bitmask64

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
NO COMMENTS
Constants
hmac-sha1 1ull hmac-sha1 NO COMMENTS
hmac-sha2-256 2ull hmac-sha2-256 NO COMMENTS
hmac-sha2-512 4ull hmac-sha2-512 NO COMMENTS
defaultValue (1ull|2ull|4ull) --- 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.






uid

Type: scalar:Uint16

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
A unique identifier for this object.