Overview Package Class Deprecated Help

macsec
ConnectivityAssociation

This class represents a global connectivity association configuration.

public class ConnectivityAssociation

Properties
administrativeState

type=netw.AdministrativeState
default=tmnxOutOfService
Displayed(tab/group)=Administrative State
anySecReserved Specifies whether this CA is reserved for use by ANYSec.

type=boolean
default=false
Displayed(tab/group)=ANYSec Reserved
description

type=string
default=
minimum=0
maximum=80
Displayed(tab/group)=Description
hsmConfigPointer HSM Config pointer.

type=Pointer
default=
Displayed(tab/group)=Hardware Security Module (/Keying Parameters)
hsmMode Key source for key generation.

type=hsm.HsmMode
default=local
Displayed(tab/group)=Key Source (/Keying Parameters)
keyingDateRun Indicates the starting date of the latest keying.

type=Date
access=read-only
Displayed(tab/group)=Date Run (/Keying Status)
keyingFailedNodeIpAddress Indicates the node where the failure occurs. If the failure occurs on multiple nodes, the first such node will be returned.

type=string
access=read-only
default=0.0.0.0
maximum=50
Displayed(tab/group)=Failed Site (/Keying Status)
keyingFailureDetails Indicates the detailed failure messages, if any.

type=string
access=read-only
default=
maximum=255
Displayed(tab/group)=Failure Details (/Keying Status)
keyingStatus Indicates keying status.

type=macsec.KeyingStatus
access=read-only
default=none
Displayed(tab/group)=Last Keying Status (/Keying Status)
macsec.CASite-Set type=Children-Set
macsec.StaticCAK-Set type=Children-Set
replayProtect Specifies whether replay protection is enabled

type=boolean
default=false
Displayed(tab/group)=Replay Protection
replayWindowSize Specifies the size of the replay protection window

type=long
default=0
minimum=0
maximum=4294967294
Displayed(tab/group)=Replay Window Size
skipOfflineNodes Typically any failure encountered in a keying operation (manual global PSK creation, manual PSK distribution, or scheduled rekey) will cause the operation to abort immediately and the keying status be marked as a failure.

This attribute specifies whether a keying operation should skip any offline nodes. If false, the keying operation will abort at the first offline node. If true, the keying operation will ignore offline nodes and continues with the rest of the nodes.

type=boolean
default=true
Displayed(tab/group)=Skip Offline Nodes (/Keying Parameters)
  
Properties inherited from macsec.AbstractConnectivityAssociation
caName, cipherSuite, clearTagMode, encryptOffset, macsecEncrypt, sakDistributionMode
 
Properties inherited from ManagedObject
actionMask, children-Set, deploymentState, isFaultSquelched, name, objectFullName, selfAlarmed
 
Methods

addCASites

Add one or more sites under the connectivity association.
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.
siteIdList : List (string) - List of siteIds.
caFullName : string -
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Exceptions:
macsec.ConnectivityAssociation.addCASitesException

deleteCASites

Deletes a list of specified CA sites under the connectivity association.
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.
aInCaSiteIdList : List (string) -
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false

resetInProgressKeyingStatus

Resets any "In Progress" keying status to "Failed" in this connectivity association. Please note, this method is of restricted access. Access privilege is required. Please contact the NFM-P customer support for more information.
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