macsec
StaticCAK

Instance containing configuration information for static CAK. It can be global or local (i.e. with a valid siteId).



public class StaticCAK

Properties
activePskIndex Specifies the active pre-shared-key index for encrypting outgoing MKA PDUs. The value of this attribute should be synced all the time between the local and the global instances. An alarm will be raised if the values are different between the local and the global.

type=int
default=1
minimum=1
maximum=2
Displayed(tab/group)=Active PSK Index, Active PSK Index (/Global Configuration)

caName Specifies the name of the connectivity association.

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

helloIntUnits

type=macsec.HelloIntUnitsType
access=read-only
default=0
Displayed(tab/group)=Hello Interval Units

helloInterval Specifies the time interval between each MKA hello. The valid values can be 1 to 6 seconds or 500 milliseconds. The value of this attribute should be combined with 'helloIntUnits' to see what the hello-interval is set on the node. All sites of a CA should config the same helloInterval as the global, otherwise an out of sync alarm will be raised until the locals and the global have the same value

type=int
default=2
minimum=1
maximum=500
Displayed(tab/group)=MKA Hello Interval

inheritanceMask Specifies the attribute value to be inherited from parent object. This one is only used for local StaticCAK,

type=long
default=unspecified
bits=
    0x1: keyServerPriority
    0x2: helloInterval

keyServerPriority Specifies the key server priority used by the MACsec Key Agreement (MKA) protocol to select the key server when MACsec is enabled using static CAK security mode.

type=int
default=16
minimum=0
maximum=255
Displayed(tab/group)=Key Server Priority

macsec.MacSecScheduledTask-Set type=Children-Set
macsec.PreSharedKey-Set type=Children-Set
siteId For instance with default siteId, it is global configuration. Otherwise, it is local.

type=string
access=read-only
default=0.0.0.0
Displayed(tab/group)=Site ID (/CA Site)

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

createPsk

Creates a global PSK object with specified index and encryption type, and distributes it to all associated sites.
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.
instanceFullName : string - the full name of the object.
aInPskIndex : int -
aInEncryptionType : macsec.EncryptType -
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false

deletePsk

Deletes the global PSK, and remove the local PSK from all associated sites.
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.
instanceFullName : string - the full name of the object.
aInPskIndex : int -
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false

distributePSKs

Distribute PSKs on the nodes. Please note, this method is intended to be called from global StaticCAK instances only.
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.
instanceFullName : string - the full name of the object.
aInSiteIdList : List (string) -
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false

syncWithGlobal

Sync the attributes values (which are defined to be synced with global) on local StaticCAK with global.
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.
instanceFullName : string - the full name of the object.
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Exceptions:
macsec.StaticCAK.syncWithGlobalException
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