netw
DiscoveredPhysicalLink

A Physical Link created dynamically (LLDP or CPAM).



public class DiscoveredPhysicalLink

Properties
cac.EndpointAPhysicalLinkBandwidth-Set type=Children-Set
cac.EndpointBPhysicalLinkBandwidth-Set type=Children-Set
description Description can be modified by user.

type=string
default=
minimum=0
maximum=254
Displayed(tab/group)=Description

discoveryTime The time when link was discovered first

type=Date
access=read-only
Displayed(tab/group)=Discovery Time (/Reference)

displayedName Displayed Name is auto populated and can also be modified by user.

type=string
default=
minimum=0
maximum=254
Displayed(tab/group)=Name

endPointAChassisId ID of endpoint A. This can be a IP address, MAC Address etc

type=string
access=read-create
Mandatory on create
Displayed(tab/group)=Endpoint A Chassis ID (/Endpoint A), Endpoint A Chassis ID (/Endpoint A - Lag)

endPointAChassisType Type that identifies the nearEndpoint endpoint. Could be MAC Address, IP address, etc..

type=lldp.ChassisIdType
access=read-create
Mandatory on create
Displayed(tab/group)=Endpoint A Chassis Type (/Endpoint A), Endpoint A Chassis Type (/Endpoint A - Lag)

endPointAPortId SNMP port ID of endpoint A. This can be zero if it is a link originating from a unmanaged node (created from CPAM).

type=string
access=read-create
minimum=1
maximum=255
Mandatory on create
Displayed(tab/group)=Endpoint A Port ID (/Endpoint A)

endPointBChassisId ID of endpoint B. This can be a IP address, MAC Address etc ....

type=string
access=read-create
Mandatory on create
Displayed(tab/group)=Endpoint B Chassis ID (/Endpoint B), Endpoint B Subnet ID (/Endpoint B - Subnet), Endpoint B Chassis ID (/Endpoint B - Lag)

endPointBChassisType Type that identifies the far endpoint. Could be MAC Address, IP address, Subnet etc..

type=lldp.ChassisIdType
access=read-create
Mandatory on create
Displayed(tab/group)=Endpoint B Chassis Type (/Endpoint B), Endpoint B Type (/Endpoint B - Subnet), Endpoint B Chassis Type (/Endpoint B - Lag)

endPointBPortId SNMP port ID of endpoint B.

type=string
access=read-create
minimum=1
maximum=255
Mandatory on create
Displayed(tab/group)=Endpoint B Port ID (/Endpoint B)

endpointBSubnetPointer

type=Pointer
access=read-create
default=
Mandatory on create
Displayed(tab/group)=Endpoint B Subnet Pointer (Endpoint Info/Endpoint B - Subnet)

gneInterfaceEndpointAPointer A pointer to a generic NE interface at endpoint A.

type=Pointer
access=read-create
default=
Mandatory on create
Displayed(tab/group)=GNE Endpoint A - Interface (/Endpoint A - Generic NE Interface), Endpoint A GNE Interface Pointer (Endpoint Info/Endpoint A - Generic NE Interface)

gneInterfaceEndpointBPointer A pointer to a generic NE interface at endpoint B.

type=Pointer
access=read-create
default=
Mandatory on create
Displayed(tab/group)=GNE Endpoint B - Interface (/Endpoint B - Generic NE Interface), Endpoint B GNE Interface Pointer (Endpoint Info/Endpoint B - Generic NE Interface)

isLagDegraded Indicates if this discovered link is part of a degraded LAG (1 or more Physical Links operationally down)

type=boolean
access=read-only
default=false
Displayed(tab/group)=LAG Degraded

isReference Specifies if this object has been referenced.

type=boolean
access=read-only
Displayed(tab/group)=Link Referenced (/Reference)

linkDiscoveredFrom Represents which protocol/application created physical link.

type=netw.LinkDiscoveredFrom
access=read-create
Mandatory on create
Displayed(tab/group)=Link Discovered from

linkType Represents the type of link (Point to Point, broadcast).

type=netw.LinkType
access=read-create
Mandatory on create
Displayed(tab/group)=Link Type

lldpDisableTime The time since when the lldp is administratively shutdown

type=Date
access=read-only
Displayed(tab/group)=LLDP Disabled since (/Reference)

physicalLinkScope Represents transmission scope of the physical link.

type=lldp.DestAddressType
access=read-create
Mandatory on create
Displayed(tab/group)=Physical Link Scope

physicalinkPointers Physical Links represented by this LAG Link

type=Set (Pointer)

referenceTime The time the last reference was created

type=Date
access=read-only
Displayed(tab/group)=Reference Time (/Reference)

remotePeerPointers Set of LLDP Remote Peers FDNs which they use this link.

type=Set (Pointer)
access=read-only

underlyingEndpointAPhysLinkPointer Indicates the underlying physical link on Endpoint A, if one exists.

type=Pointer
access=read-only
default=
Displayed(tab/group)=Underlying Endpoint A Physical Link (Underlying Physical Links)

underlyingEndpointBPhysLinkPointer Indicates the underlying physical link on Endpoint B, if one exists.

type=Pointer
access=read-only
default=
Displayed(tab/group)=Underlying Endpoint B Physical Link (Underlying Physical Links)

userName The user who referenced the link last

type=string
access=read-only
default=
minimum=1
maximum=40
Displayed(tab/group)=User Name (/Reference)

usesManagedEndpointA Whether endpoint A is managed or not.

type=boolean
access=read-create
default=true
Displayed(tab/group)=Managed Endpoint A

 
Overridden Properties
endPointAType Type of endpoint A

access=read-only

endPointBType Type of endpoint B

access=read-only

endpointAPointer A pointer to the physical port at endpoint A.

endpointBPointer A pointer to the physical port at endpoint B, if usesManagedEndpointB is true.

networkElementEndpointAPointer A pointer to the network element at endpoint A.

networkElementEndpointBPointer A pointer to the network element at endpoint B.

 
Properties inherited from netw.LagMemberCapableLink
endPointALagMembershipId, endPointBLagMembershipId, isLagMember
 
Properties inherited from netw.AbstractPhysicalLink
anyEndpointAdminUp, duplicateLinkConfigured, duplicateLinkPointers, endPointASiteId, endPointASiteName, endPointAType, endPointBSiteId, endPointBSiteName, endPointBType, endpointABundleInterfacePointer, endpointALagInterfacePointer, endpointAPointer, endpointBBundleInterfacePointer, endpointBLagInterfacePointer, endpointBPointer, hasProblem, lastAuditTime, networkElementEndpointAPointer, networkElementEndpointBPointer, operationalState, physicalLinkLagLacpKeyMisconfigured, physicalLinkMisconfigured, physicalLinkMismatchConfigured, rca.Problem-Set, upperLayerAdjacencyPointer, usesManagedEndpointB
 
Properties inherited from ManagedObject
actionMask, children-Set, deploymentState, isFaultSquelched, name, objectFullName, selfAlarmed
 
Methods

cleanUpReference

Cleans all down links and subnets from reference.
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.
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false

cleanUpReferenceInTopologyGroup

Cleans all down links and subnets from reference in selected topology group.
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.
topologyGroup : string - Active NE group.
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false

cleanUpReferenceSelected

Cleans selected down links and subnets from reference.
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.
fdns : List (string) - FDNs of the selected discovered physical links.
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false

clearReference

Clears the references.
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.
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false

clearReferenceInTopologyGroup

Clears the references for failed discovered links in selected topology group.
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.
topologyGroup : string - Active NE group.
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false

clearReferenceSelected

Clears the references for selected links.
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.
fdns : List (string) - FDNs of the selected discovered physical links.
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false

deleteDuplicatePhysicalLinks

Deletes all manually created Physical Links that are duplicates of a Discovered Physical Link.
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.
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false

setReference

Sets the reference.
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.
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false

setReferenceInTopologyGroup

Sets the reference for all discovered links in selected topology group.
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.
topologyGroup : string - Active NE group.
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false

setReferenceSelected

Sets the reference for selected links.
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.
fdns : List (string) - FDNs of the selected discovered physical links.
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Methods inherited from netw.AbstractPhysicalLink
findBwUsage