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 - APIC NX Processing: Disabled
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 ]

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: aaa:RbacAnnotation, tag:Annotation, tag:Tag,

Containers Hierarchies

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

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

Inheritance

naming:NamedObject An abstract base class for an object that contains a name.  ├ pol:Obj Represents a generic policy object.    ├ pol:Comp Represents a policy component. This object is part of the policy definition.      ├ 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        ├ comm:Shell SuperClass for shell-based access (Ssh and Telnet) and not directly used for user configuration.          ├ comm:Ssh Object that encompasses properties related to Secure Shell access to the APIC, namely admin-state (default=enabled) and port(default=22).

                comm:Ssh:creation__comm_Ssh

                comm:Ssh:modification__comm_Ssh

                comm:Ssh:deletion__comm_Ssh

                

adminSt

Type: comm:AdminState
Primitive Type: scalar:Enum8

Overrides:comm:Comp:adminSt

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:

The state of SSH communication service. This can be enabled or disabled.

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_.:-]+

NO COMMENTS

childAction

Type: mo:ModificationChildAction
Primitive Type: scalar:Bitmask32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelChildAction

Delete or ignore. For internal use only.

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\\!#$%()*,-./:;@ _{|}~?&+]+

Specifies the description of a policy component.

dn

Type: reference:BinRef

Units: null
Encrypted: false
Access: implicit
Category: TopLevelDn

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

NO COMMENTS

lcOwn

Type: mo:Owner
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular

A value that indicates how this object was created. For internal use only.

modTs

Type: mo:TStamp
Primitive Type: scalar:Date

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular

The time when this object was last modified.

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_.:-]+

null

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_.-]+

NO COMMENTS

passwordAuth

Type: comm:AdminState
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:

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

The SSH port.

proto

Type: comm:Protocol
Primitive Type: scalar:Enum8

Overrides:comm:Comp:proto

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular

The list of protocols to match.

rn

Type: reference:BinRN

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRn

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:

NO COMMENTS

sshMacs

Type: comm:SshMacTypes
Primitive Type: scalar:Bitmask64

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:

NO COMMENTS

status

Type: mo:ModificationStatus
Primitive Type: scalar:Bitmask32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelStatus

The upgrade status. This property is for internal use only.

uid

Type: scalar:Uint16

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular

A unique identifier for this object.