Overview Package Class Deprecated Help

policy
PolicyDefinition

public abstract class PolicyDefinition

Properties
configurationAction

type=policy.ConfigurationAction
default=mergeIfExists
configurationMode

type=policy.ConfigurationMode
access=read-only
default=draft
Displayed(tab/group)=Configuration Mode (/Policy Configuration)
discoveryState Only applicable to the global policy. Set to "inProgress" if the global policy is created as part of the specific NE resync during the full node resync or node discovery. At the end of full node resync, if the resync is successful, the global policy is completely updated from first discovered local policy and its discoveryState is set to "completed". Otherwise, the global policy is not updated and its discoveryState is set to "failed". For "failed" global policy, it will be updated by next successful full node resync or synchronized from the specific local policy. Set to "initialized" if the global policy is created by SNMP trap notification. User may need to synchronize the global policy manually with the specific local policy. Set to "N/A" if the global policy is created or modified by a NFM-P user.

type=policy.DiscoveryState
access=read-only
default=notApplicable
Displayed(tab/group)=Discovery State (/Policy Configuration)
distributionMode

type=policy.DistributionMode
access=read-only
default=syncWithGlobal
Displayed(tab/group)=Distribution Mode (/Policy Configuration)
isMaster

type=boolean
access=read-only
default=false
lastSyncTime Only applicable to the global policy. Specifies the time at which latest sync occurred.

type=Date
access=read-only
default=0
Displayed(tab/group)=Last Sync Time (/Policy Configuration)
numberOfUnderlyingPolicyItems

DEPRECATED: 9.0.R1 - SAM internal use only - value was not guaranteed to be accurate for all policy types - Use countInstance method instead
type=int
access=read-only
default=0
origin Only applicable to the global policy. Set to the siteId if the policy is created as the part of the specific NE resync or by SNMP notification. Set to user name if the policy is created by a NFM-P user.

type=string
access=read-only
default=N/A
maximum=50
Displayed(tab/group)=Last Sync From (/Policy Configuration)
policyMode

type=policy.PolicyMode
default=static
Displayed(tab/group)=Policy Mode (/Policy Configuration)
policySyncGroupPointer The FDN for the policy sync group.

type=Pointer
access=read-only
default=
 
Overridden Properties
displayedName

policyType

 
Properties inherited from policy.PolicyObject
description, displayedName, globalPolicy, id, isLocal, policyType, siteId, siteName, templateObject
 
Properties inherited from ManagedObject
actionMask, children-Set, deploymentState, isFaultSquelched, name, objectFullName, selfAlarmed
 
Methods

distribute

The global policy is distributed to the NEs specified in siteIds. If the distribution fails NFM-P validation for one NE, the global policy would not be distributed to any NEs. The max size of NEs which can be distributed is calculated from the policyDistributionMaxObjectLimit divided by the number of items in the global policy. The policyDistributionMaxObjectLimit is defined in nms-server.xml. Use policy.PolicyDefinition.distributeV2() for scaled distribution.
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.
siteIds : List (string) - The siteId list for distribution. The empty list means that the global policy is distributed to all applicable NEs
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Output Parameters:
objectFullName : string -

distributeUsingGroups

The global policy is distributed to the NEs present in the groups. If the distribution fails for one NE, the distribution continues for the rest of the NEs. A JMS message is sent back to indicate the list of failed 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.
groupInfoList : List (Pointer) - The group pointer list for distribution.
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Output Parameters:
objectFullName : string - The full name of the global policy to be distributed.

distributeV2

The global policy is distributed to the NEs specified in siteIds. If the distribution fails for one NE, the distribution continues for the rest of NEs. The JMS message is sent back to indicate the list of failed 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.
siteIds : List (string) - The siteId list for distribution. If the list is empty the behavior is driven by the attribute allSitesIncluded.
allSitesIncluded : boolean - (Optional) (Optional) The default is "false". Applicable only if siteIds is an empty list. If allSitesIncluded is true, the policy is distributed to all applicable NEs.
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Output Parameters:
objectFullName : string - The full name of the global policy to be distributed.

evaluatePolicy

Input Parameters:
instanceFullName : string - the full name of the object.
inputs : List (generic.CommonManagedEntityConfigurationInformation) - List of input config info objects.
resultFilter : ResultFilter - (Optional) Filter for narrowing down the information returned per object
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Output Parameters:
results : List (generic.CommonManagedEntityConfigurationInformation) - List of output config info objects.

findGlobal

Find the global policy for this local definition.
Input Parameters:
instanceFullName : string - the full name of the object.
resultFilter : ResultFilter - (Optional) Filter for narrowing down the information returned per object
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Output Parameters:
infoList : List (generic.CommonManagedEntityInformation) -

findLocal

Find all the local definitions under this global policy.
Input Parameters:
instanceFullName : string - the full name of the object.
resultFilter : ResultFilter - (Optional) Filter for narrowing down the information returned per object
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Output Parameters:
infoList : List (generic.CommonManagedEntityInformation) -

findReleased

Find the most recent released policy.
Input Parameters:
instanceFullName : string - the full name of the object.
resultFilter : ResultFilter - (Optional) Filter for narrowing down the information returned per object
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Output Parameters:
result : generic.CommonManagedEntityInformation -
Exceptions:
policy.PolicyDefinition.findReleasedException

getSyncTaskResult

Method to get sync task result
Input Parameters:
distinguishedName : Pointer - Distinguished Name of policy
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Output Parameters:
syncResult : int -
Exceptions:
policy.PolicyDefinition.getSyncTaskResultException

resetToReleasedPolicy

Reset the global policy to the most recent released policy. The local policies are not affected.
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
Output Parameters:
objectFullName : string -
Exceptions:
policy.PolicyDefinition.resetToReleasedPolicyException

setConfigurationModeToDraft

Set configuration mode to Draft. It is only applicable for the global policy.
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
Output Parameters:
configurationMode : int -

setConfigurationModeToReleased

Sets the configuration mode to Released and distributes the global policy to the local definitions network-wide. It is only applicable for the global policy.
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
Output Parameters:
configurationMode : int -

setDistributionModeToLocalEditOnly

Set distribution mode to local edit only for local policies on the sites specified by siteIds. If it is called from the local policy, only that local policy is updated.
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.
siteIds : List (string) -
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Output Parameters:
distributionMode : int -

setDistributionModeToSyncWithGlobal

Set distribution mode to Sync with Global for local policies on the sites specified by siteIds. It automatically synchronize local policies with the most recent released global policy. If it is called from the local policy, only that local policy is updated.
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.
siteIds : List (string) -
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Output Parameters:
distributionMode : int -

syncTo

If it is called from global policy, the selected local policy is copied into this global policy. If configuration mode is not used, the synchronized global policy is distributed to existing local definitions network-wide. If it is called from the local policy, the selected local policy is copied into this local policy and applied to the network.
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.
siteId : string -
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Output Parameters:
objectFullName : string -

syncToLocalWithResync

Is called from the local policy,resync of the local policy is done before the selected local policy is copied into this local policy and applied to the network.
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.
siteId : string -
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Output Parameters:
objectFullName : string -
Supported Network Elements
7450 ESS
7210 SAS M
7210 SAS X
7210 SAS E
7210 SAS D
7210 SAS K
7210 SAS T
7210 SAS Mxp
7210 SAS Dxp
7210 SAS S/Sx
7210 SAS R
7250 IXR
7750 SR
7705 SAR Gen 2
7705 SAR Hm
7705 SAR
7705 SAR H
7701 CPAA
OS6850/6850E
OS6855
OS6400
Wavence SM
OS6250
OS6450
OS6350
OS9700E/9800E
OS6900
OS6860E/OS6860N
OS6870
OS6865
OS6560/OS6560E
OS6570M
OS6465
DC VSC
DC 7850
DC 210
DC VSA8
7950 XRS
Generic NE