Class comm:Https (CONCRETE)

Class ID:1578
Class Label: HTTP SSL Configuration
Encrypted: false - Exportable: true - Persistent: true - Configurable: true - Subject to Quota: 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: true, HasStats: true, HasFaults: true, HasHealth: true, HasEventRules: false ]

HTTPS

Naming Rules
RN FORMAT: https

    [1] PREFIX=https


DN FORMAT: 

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

                


Diagram

Super Mo: comm:Web,
Container Mos: comm:Pol (deletable:no),
Contained Mos: comm:Cipher, comm:WebProxy,
Relations To: pki:KeyRing,
Relations: comm:RsKeyRing,


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:Https HTTPS
[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:Https HTTPS


Contained Hierarchy
[V] comm:Https HTTPS
 ├
[V] comm:Cipher 
 ├
[V] comm:RsKeyRing A source relation to a key ring.
 
 ├
[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: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] health:Inst A base class for a health score instance.(Switch only)
 ├
[V] comm:WebProxy Web proxy
 ├
[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] 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] 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:Web SuperClass for web based access (HTTP and HTTPS) and not directly used for user configuration.
 
 
 
 
 ├
[V] comm:Https HTTPS


Stat Counters
scalar:Uint32 GAUGE: comm:WebConnStates:wait(connections)
           current waiting connections
          Comments: current connections in wait
scalar:Uint32 GAUGE: comm:WebConnStates:write(connections)
           current writing connections
          Comments: current connections in write
scalar:Uint32 GAUGE: comm:WebConnStates:read(connections)
           current reading connections
          Comments: current connections in read
scalar:Uint64 COUNTER: comm:WebConn:handled(connections)
           total handled connections
          Comments: cumulative handled connections
scalar:Uint64 COUNTER: comm:WebConn:accepted(connections)
           total accepted connections
          Comments: cumulative accepted connections
scalar:Uint32 GAUGE: comm:WebConn:active(connections)
           current active connections
          Comments: current active connections
scalar:Uint64 COUNTER: comm:WebReq:requests(requests)
           total requests
          Comments: cumulative requests


Stats
[V] comm:Https HTTPS
 ├
[V] comm:WebConnAg15min A class that represents the most current aggregated statistics for web connections in a 15 minute sampling interval. This class updates every 5 minutes.
 ├
[V] comm:WebConnAg1d A class that represents the most current aggregated statistics for web connections in a 1 day sampling interval. This class updates every hour.
 ├
[V] comm:WebConnAg1h A class that represents the most current aggregated statistics for web connections in a 1 hour sampling interval. This class updates every 15 minutes.
 ├
[V] comm:WebConnAg1mo A class that represents the most current aggregated statistics for web connections in a 1 month sampling interval. This class updates every day.
 ├
[V] comm:WebConnAg1qtr A class that represents the most current aggregated statistics for web connections in a 1 quarter sampling interval. This class updates every day.
 ├
[V] comm:WebConnAg1w A class that represents the most current aggregated statistics for web connections in a 1 week sampling interval. This class updates every day.
 ├
[V] comm:WebConnAg1year A class that represents the most current aggregated statistics for web connections in a 1 year sampling interval. This class updates every day.
 ├
[V] comm:WebConnAgHist15min A class that represents historical aggregated statistics for web connections in a 15 minute sampling interval. This class updates every 5 minutes.
 ├
[V] comm:WebConnAgHist1d A class that represents historical aggregated statistics for web connections in a 1 day sampling interval. This class updates every hour.
 ├
[V] comm:WebConnAgHist1h A class that represents historical aggregated statistics for web connections in a 1 hour sampling interval. This class updates every 15 minutes.
 ├
[V] comm:WebConnAgHist1mo A class that represents historical aggregated statistics for web connections in a 1 month sampling interval. This class updates every day.
 ├
[V] comm:WebConnAgHist1qtr A class that represents historical aggregated statistics for web connections in a 1 quarter sampling interval. This class updates every day.
 ├
[V] comm:WebConnAgHist1w A class that represents historical aggregated statistics for web connections in a 1 week sampling interval. This class updates every day.
 ├
[V] comm:WebConnAgHist1year A class that represents historical aggregated statistics for web connections in a 1 year sampling interval. This class updates every day.
 ├
[V] comm:WebConnStatesAg15min A class that represents the most current aggregated statistics for web connections state in a 15 minute sampling interval. This class updates every 5 minutes.
 ├
[V] comm:WebConnStatesAg1d A class that represents the most current aggregated statistics for web connections state in a 1 day sampling interval. This class updates every hour.
 ├
[V] comm:WebConnStatesAg1h A class that represents the most current aggregated statistics for web connections state in a 1 hour sampling interval. This class updates every 15 minutes.
 ├
[V] comm:WebConnStatesAg1mo A class that represents the most current aggregated statistics for web connections state in a 1 month sampling interval. This class updates every day.
 ├
[V] comm:WebConnStatesAg1qtr A class that represents the most current aggregated statistics for web connections state in a 1 quarter sampling interval. This class updates every day.
 ├
[V] comm:WebConnStatesAg1w A class that represents the most current aggregated statistics for web connections state in a 1 week sampling interval. This class updates every day.
 ├
[V] comm:WebConnStatesAg1year A class that represents the most current aggregated statistics for web connections state in a 1 year sampling interval. This class updates every day.
 ├
[V] comm:WebConnStatesAgHist15min A class that represents historical aggregated statistics for web connections state in a 15 minute sampling interval. This class updates every 5 minutes.
 ├
[V] comm:WebConnStatesAgHist1d A class that represents historical aggregated statistics for web connections state in a 1 day sampling interval. This class updates every hour.
 ├
[V] comm:WebConnStatesAgHist1h A class that represents historical aggregated statistics for web connections state in a 1 hour sampling interval. This class updates every 15 minutes.
 ├
[V] comm:WebConnStatesAgHist1mo A class that represents historical aggregated statistics for web connections state in a 1 month sampling interval. This class updates every day.
 ├
[V] comm:WebConnStatesAgHist1qtr A class that represents historical aggregated statistics for web connections state in a 1 quarter sampling interval. This class updates every day.
 ├
[V] comm:WebConnStatesAgHist1w A class that represents historical aggregated statistics for web connections state in a 1 week sampling interval. This class updates every day.
 ├
[V] comm:WebConnStatesAgHist1year A class that represents historical aggregated statistics for web connections state in a 1 year sampling interval. This class updates every day.
 ├
[V] comm:WebReqAg15min A class that represents the most current aggregated statistics for web requests in a 15 minute sampling interval. This class updates every 5 minutes.
 ├
[V] comm:WebReqAg1d A class that represents the most current aggregated statistics for web requests in a 1 day sampling interval. This class updates every hour.
 ├
[V] comm:WebReqAg1h A class that represents the most current aggregated statistics for web requests in a 1 hour sampling interval. This class updates every 15 minutes.
 ├
[V] comm:WebReqAg1mo A class that represents the most current aggregated statistics for web requests in a 1 month sampling interval. This class updates every day.
 ├
[V] comm:WebReqAg1qtr A class that represents the most current aggregated statistics for web requests in a 1 quarter sampling interval. This class updates every day.
 ├
[V] comm:WebReqAg1w A class that represents the most current aggregated statistics for web requests in a 1 week sampling interval. This class updates every day.
 ├
[V] comm:WebReqAg1year A class that represents the most current aggregated statistics for web requests in a 1 year sampling interval. This class updates every day.
 ├
[V] comm:WebReqAgHist15min A class that represents historical aggregated statistics for web requests in a 15 minute sampling interval. This class updates every 5 minutes.
 ├
[V] comm:WebReqAgHist1d A class that represents historical aggregated statistics for web requests in a 1 day sampling interval. This class updates every hour.
 ├
[V] comm:WebReqAgHist1h A class that represents historical aggregated statistics for web requests in a 1 hour sampling interval. This class updates every 15 minutes.
 ├
[V] comm:WebReqAgHist1mo A class that represents historical aggregated statistics for web requests in a 1 month sampling interval. This class updates every day.
 ├
[V] comm:WebReqAgHist1qtr A class that represents historical aggregated statistics for web requests in a 1 quarter sampling interval. This class updates every day.
 ├
[V] comm:WebReqAgHist1w A class that represents historical aggregated statistics for web requests in a 1 week sampling interval. This class updates every day.
 ├
[V] comm:WebReqAgHist1year A class that represents historical aggregated statistics for web requests in a 1 year sampling interval. This class updates every day.


Events
                comm:Https:modification__comm_Https
comm:Https:creation__comm_Https
comm:Https:modification__comm_Https
comm:Https:deletion__comm_Https


Faults
                


Fsms
                


Properties Summary
Defined in: comm:Https
comm:AdminState
          scalar:Enum8
adminSt  (comm:Https:adminSt)
           Overrides:comm:Comp:adminSt
           The state of HTTPS communication service. This can be enabled or disabled.
comm:DHParam
          scalar:Enum8
dhParam  (comm:Https:dhParam)
           NO COMMENTS
reference:BinRef monPolDn  (comm:Https:monPolDn)
           The monitoring policy attached to this observable object.
naming:Name
          string:Basic
name  (comm:Https:name)
           Overrides:pol:Obj:name | naming:NamedObject:name
           null
comm:Port
          scalar:Uint32
port  (comm:Https:port)
           Overrides:comm:Comp:port
           The port used for HTTPS communication service.
comm:SslProtocolTypes
          scalar:Bitmask64
sslProtocols  (comm:Https:sslProtocols)
           The Secure Socket Layer (SSL) protocol.
comm:VisoreAccess
          scalar:Enum8
visoreAccess  (comm:Https:visoreAccess)
           NO COMMENTS
Defined in: comm:Web
comm:AllowCredentialState
          scalar:Enum8
accessControlAllowCredential  (comm:Web:accessControlAllowCredential)
           NO COMMENTS
comm:UrlList
          string:Basic
accessControlAllowOrigins  (comm:Web:accessControlAllowOrigins)
          
scalar:Uint32 maxRequestStatusCount  (comm:Web:maxRequestStatusCount)
           NO COMMENTS
comm:Protocol
          scalar:Enum8
proto  (comm:Web:proto)
           Overrides:comm:Comp:proto
           The list of protocols to match.
scalar:Uint32 throttleRate  (comm:Web:throttleRate)
           NO COMMENTS
comm:AdminState
          scalar:Enum8
throttleSt  (comm:Web:throttleSt)
           NO COMMENTS
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: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.
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:Modifiable
mo:TStamp
          scalar:Date
modTs  (mo:Modifiable:modTs)
           The time when this object was last modified.
Properties Detail

accessControlAllowCredential

Type: comm:AllowCredentialState
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
NO COMMENTS
Constants
enabled 1 Enabled NO COMMENTS
disabled 2 Disabled NO COMMENTS
DEFAULT disabled(2) Disabled NO COMMENTS





accessControlAllowOrigins

Type: comm:UrlList
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "256"
        Allowed Chars:
            Regex: [a-zA-Z0-9-_:/.,\*\s]+
    Comments:
Constants
defaultValue "http://127.0.0.1:8000" --- NO COMMENTS





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





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.



dhParam

Type: comm:DHParam
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
NO COMMENTS
Constants
none 0 None NO COMMENTS
1024 1 1024 NO COMMENTS
2048 2 2048 NO COMMENTS
4096 3 4096 NO COMMENTS
DEFAULT none(0) None 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.



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





maxRequestStatusCount

Type: scalar:Uint32

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: (long)0l  max: (long)1024l
    Comments:
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





monPolDn

Type: reference:BinRef

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The monitoring policy attached to this observable object.



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 "https" --- 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)1l max: (long)65535l
    Comments:
The port used for HTTPS communication service.
Constants
defaultValue 443u --- 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.



sslProtocols

Type: comm:SslProtocolTypes
Primitive Type: scalar:Bitmask64

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
The Secure Socket Layer (SSL) protocol.
Constants
TLSv1 1ull TLSv1 NO COMMENTS
TLSv1.1 2ull TLSv1.1 NO COMMENTS
TLSv1.2 4ull TLSv1.2 NO COMMENTS
defaultValue (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.






throttleRate

Type: scalar:Uint32

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: (long)1l  max: (long)100l
    Comments:
NO COMMENTS
Constants
defaultValue 2u --- NO COMMENTS





throttleSt

Type: comm:AdminState
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
NO COMMENTS
Constants
enabled 1 Enabled NO COMMENTS
disabled 2 Disabled NO COMMENTS
DEFAULT enabled(1) Enabled NO COMMENTS





uid

Type: scalar:Uint16

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



visoreAccess

Type: comm:VisoreAccess
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
NO COMMENTS
Constants
enabled 1 Enabled NO COMMENTS
disabled 2 Disabled NO COMMENTS
DEFAULT enabled(1) Enabled NO COMMENTS