macsec
MacsecInterface

This class represents a MACsec Interface configuration.



public class MacsecInterface

Stats:
macsec.MacSecPortStats macsec.MacSecTxSAStats macsec.MacSecTxSCStats

Properties
administrativeState

type=netw.AdministrativeState
default=tmnxOutOfService
Displayed(tab/group)=Administrative State

caName Associated MACsec Connectivity Association.

type=string
default=
minimum=0
maximum=32
Displayed(tab/group)=Connectivity Association

eapolDestAddress Specifies the MAC address of the destination Extensible Authentication Protocol over LAN (EAPoL)

type=MacAddress
default=00-00-00-00-00-00
Displayed(tab/group)=Destination EAPoL Mac Address

encapType allMatch: when this flow type is selected all traffic pattern will be match including un-tag, single-tag or double-tag and all will be encrypted untagged: only un-tag traffic will be matched and encrypted single-tag: only dot1q traffic will be matched and encrypted. Note that either all single tag traffic can be matched or a specific dot1q tag can be matched. double-tag: only q-in-q traffic will be matched and encrypted. The service tag or the customer tag can be specifically matched or can be a wild card match * in single-tag and double-tag means to match any single/double-tag traffic Example: encap-match single-tag * Matches any single-tag traffic on port encap-match double-tag *.1 Matches only double-tag traffic on port with service tag of any and customer tag of 1 encap-match double-tag 1.* Matches only double-tag traffic on port with service tag of 1 and customer tag of any encap-match double-tag *.* Matches any double-tag traffic on port

type=macsec.EncapTypeType
default=allMatch
Displayed(tab/group)=Encap-Match Type (/Encap Match)

id Specifies ID of the sub port on the system.

type=int
access=read-create
minimum=1
maximum=1023
Mandatory on create
Displayed(tab/group)=ID

innerEncapValue Provisioned inner encap value.

type=int
default=0
minimum=0
maximum=4095
Displayed(tab/group)=Inner Encapsulation Value (/Encap Match)

ipAddressType

type=rtr.InetAddressType
access=read-create
default=ipv4

macsec.MkaSession-Set type=Children-Set
macsecPortPointer The pointer pointing to MacsecPort

type=Pointer
access=read-only
default=
Displayed(tab/group)=MACsec Port (/MACsec Port)

maxPeers Specifies the maximum number of peers supported on this port

type=int
default=0
minimum=0
maximum=32
Displayed(tab/group)=Max Peers

mkaSessionStatus Indicates the operational state of the MKA session on the Macsec Interface. When the Mka session is deleted, its value is set to "Unknown". When the Mka session is down, its value is set to "Down". An alarm is raised. When the Mka session is up, its value is set to "Up". The alarm is cleared.

type=netw.OperationalState
access=read-only
default=1
Displayed(tab/group)=MKA Session Status

outerEncapValue Provisioned outer encap value.

type=int
default=0
minimum=0
maximum=4095
Displayed(tab/group)=Outer Encapsulation Value (/Encap Match)

portName The port Name associated with the port.

type=string
access=read-only
default=
Displayed(tab/group)=Port Name

portPointer Pointer to a Port on the switch.

type=Pointer
access=read-create
default=
Mandatory on create
Displayed(tab/group)=Port

siteId

type=InetAddress
access=read-create
default=
Mandatory on create
Displayed(tab/group)=Site ID

snmpPortId

type=long
access=read-create
default=0

  
Properties inherited from ManagedObject
actionMask, children-Set, deploymentState, isFaultSquelched, name, objectFullName, selfAlarmed
 
Methods

removeMacsecInterfacesFromCA

Remove the selected interface from the CA.
Input Parameters:
deployer : Deployer - the deployment state
synchronousDeploy : boolean - (Optional) Specify whether to block until the changes have been fully deployed to the network. A value of "true" means to block. A value of "false" means to return immediately. Default: false (asynchronous)
clearOnDeployFailure : boolean - (Optional) Specify whether to clear any failed deployers. A value of "true" means to clear. A value of "false" means to leave the failed deployer. Default: false
deployRetries : int - (Optional) The number of times to attempt re-deployment during synchronous deployment. This parameter is meaningless in the asynchronous case. Default: 0
deployRetryInterval : long - (Optional) The number of milliseconds to wait between deployment retries. This parameter is meaningless in the asynchronous case. Default: 0
taskDescription : string - (Optional) A user friendly description of what the operation does. This information will be used by the task manager.
macsecInterfaceFullNames : List (Pointer) - The list of MACsec Interface full names.
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Exceptions:
macsec.MacsecInterface.removeMacsecInterfacesFromCAException
Supported Network Elements
7705 SAR Supported from 24.10.R3
7750 SR Supported from 16.0.R1
7705 SAR Gen 2
7450 ESS Supported from 16.0.R1
7210 SAS K Supported from 11.0.R6
  • Excluded chassis types: 7210 SAS-K-2F-3T, 7210 SAS-K-2F-3T ETR, 7210 SAS-K-2F-6C-4T
7210 SAS Dxp Supported from 22.9.R1
  • Excluded chassis types: 7210 SAS-Dxp-6T-4F-2SFP, 7210 SAS-Dxp-6T-4F-2SFP ETR, 7210 SAS-Dxp-10T-4F-2SFP ETR
7250 IXR Supported from 20.10.R1 until 21.2.R1
  • Excluded chassis types: 7250 IXR-R6, 7250 IXR-R4, 7250 IXR-s, 7250 IXR-e, 7250 IXR-x
Supported from 21.2.R1 until 21.7.R1
  • Excluded chassis types: 7250 IXR-R6, 7250 IXR-s, 7250 IXR-e, 7250 IXR-x
Supported from 21.7.R1 until 21.10.R1
  • Excluded chassis types: 7250 IXR-R6, 7250 IXR-s, 7250 IXR-x
Supported from 21.10.R1
  • Excluded chassis types: 7250 IXR-s, 7250 IXR-x
Product Specifics
7210 SAS Dxp 22.0
7210 SAS Dxp 23.0
7210 SAS Dxp 24.0
7210 SAS Dxp 25.0
7210 SAS K 20.0
7210 SAS K 21.0
7210 SAS K 22.0
7210 SAS K 23.0
7210 SAS K 24.0
7210 SAS K 25.0
7250 IXR 20.0
7250 IXR 21.0
7250 IXR 22.0
7250 IXR 23.0
7250 IXR 24.0
7250 IXR 25.0
7450 ESS 20.0
7450 ESS 21.0
7450 ESS 22.0
7450 ESS 23.0
7450 ESS 24.0
7450 ESS 25.0
7705 SAR Gen 2 25.0
7705 SAR 24.0
7705 SAR 25.0
7750 SR 20.0
7750 SR 21.0
7750 SR 22.0
7750 SR 23.0
7750 SR 24.0
7750 SR 25.0