Overview  Diagram  Inheritance  Events  Faults  FSMs  Properties Summary  Properties Detail 

Class macsec:AIf (ABSTRACT)

Class ID:9900
Class Label: Abstract Interface
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: [access-protocol-l1, access-protocol-l2, admin, fabric-protocol-l1, fabric-protocol-l2, tenant-ext-protocol-l2, tenant-protocol-l2]
Creatable/Deletable: no (see Container Mos for details)
Possible Semantic Scopes: Infra, Fabric,
Semantic Scope Evaluation Rule: Subclasses
Monitoring Policy Source: Relation
Monitoring Flags : [ IsObservable: false, HasStats: false, HasFaults: false, HasHealth: false, HasEventRules: false ]

This object holds macsec information that is operated at a interface level

Naming Rules 


DN FORMAT:


Diagram

Super Mo: l2:ProtIf,
Sub Mos: macsec:FabIf, macsec:If,
Relations From: nw:PathEp,
Relations To: l1:EthIf, mgmt:MgmtIf,
Relations: l2:RsEthIf, l2:RsMgmtIf, nw:RtPathToIf,


Inheritance
[V] nw:Item Ignore.
 ├
 		[V] nw:Conn A connection abstraction.
 
 		 ├
 		[V] nw:Ep A static endpoint.
 
 		 
 		 ├
 		[V] nw:ConnEp A connection endpoint abstraction.
 
 		 
 		 
 		 ├
 		[V] nw:If The interface information.
 
 		 
 		 
 		 
 		 ├
 		[V] nw:LogicalIf A logical interface abstraction.
 
 		 
 		 
 		 
 		 
 		 ├
 		[V] nw:ProtIf A protocol interface abstraction.
 
 		 
 		 
 		 
 		 
 		 
 		 ├
 		[V] l2:ProtIf A protocol interface abstraction.
 
 		 
 		 
 		 
 		 
 		 
 		 
 		 ├
 		[V] macsec:AIf  This object holds macsec information that is operated at a interface level
 
 		 
 		 
 		 
 		 
 		 
 		 
 		 
 		 ├
 		[V] macsec:FabIf 
 
 		 
 		 
 		 
 		 
 		 
 		 
 		 
 		 ├
 		[V] macsec:If 


Events


Faults


Fsms


Properties Summary
Defined in: macsec:AIf
macsec:CakName
          string:Basic 		cakName  (macsec:AIf:cakName)
           Connectivity Association Key Name (CKN)
macsec:CipherSuite
          scalar:Enum8 		cipherSuite  (macsec:AIf:cipherSuite)
           Cipher Suite
macsec:CipherSuite
          scalar:Enum8 		cipherSuiteOper  (macsec:AIf:cipherSuiteOper)
           Cipher Suite Operational
macsec:ConfOffset
          scalar:Enum8 		confOffset  (macsec:AIf:confOffset)
           Confidentiality Offset
macsec:ConfOffset
          scalar:Enum8 		confOffsetOper  (macsec:AIf:confOffsetOper)
           Confidentiality Offset Operational
kc:EntryName
          string:Basic 		keyChain  (macsec:AIf:keyChain)
           Key Chain Name
macsec:KeySvrPrio
          scalar:UByte 		keySvrPrio  (macsec:AIf:keySvrPrio)
           Key Server Priority
macsec:Timestamp
          scalar:Date 		lastSakKeyTime  (macsec:AIf:lastSakKeyTime)
           Last Secure Association Key (SAK) Key Time
macsec:AssocNum
          scalar:Uint16 		latestSakAN  (macsec:AIf:latestSakAN)
           Latest Secure Association Key (SAK) Association Number
macsec:SakKiKn
          string:Basic 		latestSakKI  (macsec:AIf:latestSakKI)
           Latest Secure Association Key (SAK) KI
macsec:SakKiKn
          string:Basic 		latestSakKN  (macsec:AIf:latestSakKN)
           Latest Secure Association Key (SAK) KN
address:MAC mac  (macsec:AIf:mac)
           The MAC address.
macsec:MbrId
          string:Basic 		mbrId  (macsec:AIf:mbrId)
           Member Identifier
macsec:MkaIfNegSt
          scalar:Enum16 		mkaNegSt  (macsec:AIf:mkaNegSt)
           MKA negotiation interface status information
macsec:MsgNum
          scalar:Uint32 		msgNumber  (macsec:AIf:msgNumber)
           Message Number (MN)
macsec:OperSt
          scalar:Enum8 		operSt  (macsec:AIf:operSt)
           The runtime state of the object or policy.
macsec:OperStQual
          scalar:Enum8 		operStQual  (macsec:AIf:operStQual)
           The chassis operational status qualifier.
nw:Counter64
          scalar:Uint64 		peerCount  (macsec:AIf:peerCount)
           Peer Count
macsec:PolConfigStatus
          scalar:Enum8 		polConfigStatus  (macsec:AIf:polConfigStatus)
           Policy Config status
l4:Port
          scalar:Uint16 		portId  (macsec:AIf:portId)
           The port identifier.
macsec:ReplayWindow
          scalar:Uint32 		replayWindow  (macsec:AIf:replayWindow)
           Replay Protection Window Size
macsec:SakExpiryTime
          scalar:Uint32 		sakExpiryTime  (macsec:AIf:sakExpiryTime)
           SAK expiry time
macsec:SakStatus
          scalar:Enum8 		sakStatus  (macsec:AIf:sakStatus)
           Secure Association Key (SAK) Status
macsec:SecPolicy
          scalar:Enum8 		secPolicy  (macsec:AIf:secPolicy)
           Security Policy
macsec:SessOperSt
          scalar:Enum8 		sessOperSt  (macsec:AIf:sessOperSt)
           Session Status
macsec:SrvFlags
          scalar:Bitmask8 		srvStatusFlags  (macsec:AIf:srvStatusFlags)
           Server Status Flags
macsec:TxSCI
          string:Basic 		txSCI  (macsec:AIf:txSCI)
           Tx-SCI (Secure Channel Identifier)
macsec:TxSSCI
          scalar:Uint32 		txSSCI  (macsec:AIf:txSSCI)
           Tx-SSCI (Short Secure Channel Identifier)
macsec:VlanTagCtrl
          scalar:Enum8 		vlanTagCtrl  (macsec:AIf:vlanTagCtrl)
           Vlan Tag Ctrl
Defined in: nw:ProtIf
nw:IfAdminSt
          scalar:Enum8 		adminSt  (nw:ProtIf:adminSt)
           The administrative state of the object or policy.
Defined in: nw:If
naming:Descr
          string:Basic 		descr  (nw:If:descr)
          
nw:IfId
          base:IfIndex 		id  (nw:If:id)
           An identifier .
Defined in: nw:Ep
naming:Name
          string:Basic 		name  (nw:Ep:name)
           Overrides:nw:Conn:name
           The name of the object.
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: nw:IfAdminSt
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The administrative state of the object or policy.
Constants
enabled 1 Enabled Enabled
disabled 2 Disabled Disabled
DEFAULT enabled(1) Enabled Enabled




cakName

Type: macsec:CakName
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Connectivity Association Key Name (CKN)


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




cipherSuite

Type: macsec:CipherSuite
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Cipher Suite
Constants
gcm-aes-128 1 128 bit GCM-AES Suite gcm-aes-128
gcm-aes-256 2 256 bit GCM-AES Suite gcm-aes-256
gcm-aes-xpn-128 3 128 bit GCM-AES Suite with Extended Packet Numbering gcm-aes-xpn-128
gcm-aes-xpn-256 4 256 bit GCM-AES Suite with Extended Packet Numbering gcm-aes-xpn-256
DEFAULT gcm-aes-xpn-256(4) 256 bit GCM-AES Suite with Extended Packet Numbering gcm-aes-xpn-256




cipherSuiteOper

Type: macsec:CipherSuite
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Cipher Suite Operational
Constants
gcm-aes-128 1 128 bit GCM-AES Suite gcm-aes-128
gcm-aes-256 2 256 bit GCM-AES Suite gcm-aes-256
gcm-aes-xpn-128 3 128 bit GCM-AES Suite with Extended Packet Numbering gcm-aes-xpn-128
gcm-aes-xpn-256 4 256 bit GCM-AES Suite with Extended Packet Numbering gcm-aes-xpn-256
DEFAULT gcm-aes-xpn-256(4) 256 bit GCM-AES Suite with Extended Packet Numbering gcm-aes-xpn-256




confOffset

Type: macsec:ConfOffset
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Confidentiality Offset
Constants
offset-0 1 Skip 0 bytes 0
offset-30 2 Skip 30 bytes 30
offset-50 3 Skip 50 bytes 50
DEFAULT offset-0(1) Skip 0 bytes 0




confOffsetOper

Type: macsec:ConfOffset
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Confidentiality Offset Operational
Constants
offset-0 1 Skip 0 bytes 0
offset-30 2 Skip 30 bytes 30
offset-50 3 Skip 50 bytes 50
DEFAULT offset-0(1) Skip 0 bytes 0




descr

Type: naming:Descr
Primitive Type: string:Basic

Like: naming:Described:descr
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
    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.


id

Type: nw:IfId
Primitive Type: base:IfIndex

Units: null
Encrypted: false
Access: create
Category: TopLevelRegular
    Comments:
An identifier .


keyChain

Type: kc:EntryName
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Key Chain Name


keySvrPrio

Type: macsec:KeySvrPrio
Primitive Type: scalar:UByte

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Key Server Priority
Constants
defaultValue 16 --- NO COMMENTS




lastSakKeyTime

Type: macsec:Timestamp
Primitive Type: scalar:Date

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Last Secure Association Key (SAK) Key Time


latestSakAN

Type: macsec:AssocNum
Primitive Type: scalar:Uint16

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Latest Secure Association Key (SAK) Association Number


latestSakKI

Type: macsec:SakKiKn
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Latest Secure Association Key (SAK) KI


latestSakKN

Type: macsec:SakKiKn
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Latest Secure Association Key (SAK) KN


mac

Type: address:MAC

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
The MAC address.


mbrId

Type: macsec:MbrId
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Member Identifier


mkaNegSt

Type: macsec:MkaIfNegSt
Primitive Type: scalar:Enum16

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
MKA negotiation interface status information
Constants
if-neg-succ 0 MKA negotiation success on the interface Successful MKA negotition
rx-val-fail 1 MKPDUs Rx Validation Failed MKPDUs Rx Validation
rx-bad-peer-mn 2 MKPDUs Rx Bad Peer Message Number MKPDUs Rx Bad Peer MN
rx-non-recent-peerlist-mn 3 MKPDUs Rx Non Recent Peerlist Message Number MKPDUs Rx Non Recent Peerlist MN
rx-drop-sakuse-kn-mismatch 4 MKPDUs Rx Drop SAKUSE, KN mismatch MKPDUs Rx Drop SAKUSE, KN mismatch
rx-not-set 5 MKPDUs Rx Drop SAKUSE, Rx Not Set MKPDUs Rx Drop SAKUSE, Rx Not Set
rx-key-mi-mismatch 6 MKPDUs Rx Drop SAKUSE, Key Member Identifier mismatch MKPDUs Rx Drop SAKUSE, Key MI mismatch
rx-an-not-inuse 7 MKPDUs Rx Drop SAKUSE, Association Number not in use MKPDUs Rx Drop SAKUSE, AN Not in Use
ks-rx-tx-notset 8 MKPDUs Rx Drop SAKUSE, Key Server Rx/Tx Not Set MKPDUs Rx Drop SAKUSE, KS Rx/Tx Not Set
rx-ethertype-mismatch 9 MKPDUs Rx Drop, Ethertype Mismatch MKPDUs Rx Drop, Ethertype Mismatch
DEFAULT if-neg-succ(0) MKA negotiation success on the interface Successful MKA negotition




msgNumber

Type: macsec:MsgNum
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Message Number (MN)


name

Type: naming:Name
Primitive Type: string:Basic

Overrides:nw:Conn:name

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
    Comments:
The name of the object.


operSt

Type: macsec:OperSt
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
The runtime state of the object or policy.
Constants
up 1 Up up
down 2 Down down
DEFAULT down(2) Down down




operStQual

Type: macsec:OperStQual
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
The chassis operational status qualifier.
Constants
up 1 Up up
admin-down 2 Administratively down Down administratively
if-down 3 Interface down Interface down
unsupported 4 Feature Unsupported on Hardware Unsupported
session-not-secured 5 Session is not secured Config Reject
DEFAULT if-down(3) Interface down Interface down




peerCount

Type: nw:Counter64
Primitive Type: scalar:Uint64

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Peer Count


polConfigStatus

Type: macsec:PolConfigStatus
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Policy Config status
Constants
status-ok 1 Status OK Status OK
status-conflict 2 Status Conflict Status Conflict
DEFAULT status-ok(1) Status OK Status OK




portId

Type: l4:Port
Primitive Type: scalar:Uint16

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
The port identifier.
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




replayWindow

Type: macsec:ReplayWindow
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Replay Protection Window Size
Constants
defaultValue 64u --- 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.


sakExpiryTime

Type: macsec:SakExpiryTime
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
SAK expiry time
Constants
disabled 0u disabled NO COMMENTS
DEFAULT disabled(0u) disabled NO COMMENTS




sakStatus

Type: macsec:SakStatus
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Secure Association Key (SAK) Status
Constants
no-rx-tx 0 No RX-Tx No RX-Tx
tx-only 1 Tx Only Tx Only
rx-only 2 Rx Only Rx Only
rx-and-tx 3 Rx And Tx Rx And Tx
DEFAULT no-rx-tx(0) No RX-Tx No RX-Tx




secPolicy

Type: macsec:SecPolicy
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Security Policy
Constants
must-secure 1 Must secure mode must-secure
should-secure 2 Should secure mode should-secure
DEFAULT should-secure(2) Should secure mode should-secure




sessOperSt

Type: macsec:SessOperSt
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Session Status
Constants
not-initialized 0 Not-Initialized not-initialized
pending 1 Pending pending
secured 2 Secured secured
DEFAULT not-initialized(0) Not-Initialized not-initialized




srvStatusFlags

Type: macsec:SrvFlags
Primitive Type: scalar:Bitmask8

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Server Status Flags
Constants
not-key-server 0 Not Key Server Not Key Server
key-server 1 Key Server Key Server
DEFAULT not-key-server(0) Not Key Server Not Key Server




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.





txSCI

Type: macsec:TxSCI
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Tx-SCI (Secure Channel Identifier)


txSSCI

Type: macsec:TxSSCI
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Tx-SSCI (Short Secure Channel Identifier)


vlanTagCtrl

Type: macsec:VlanTagCtrl
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Vlan Tag Ctrl
Constants
skip-0 0 Skip 0 VLAN Tag 0
skip-1 1 Skip 1 VLAN Tag 1
skip-2 2 Skip 2 VLAN Tags 2
skip-3 3 Skip 3 VLAN Tags 3
DEFAULT skip-0(0) Skip 0 VLAN Tag 0






Overview  Diagram  Inheritance  Events  Faults  FSMs  Properties Summary  Properties Detail