Overview Package Class Deprecated Help

propertyrules
PropertyValuePolicy

public abstract class PropertyValuePolicy

Properties
administrativeState Whether this policy is enabled (ready to use).

type=propertyrules.AdministrativeState
default=enabled
Displayed(tab/group)=Administrative State
policyId Unique ID of the policy.

type=long
access=read-create
default=0
minimum=1
maximum=5000000
Displayed(tab/group)=Policy ID
policyName Displayed name of the policy.

type=string
default=
minimum=1
maximum=40
Displayed(tab/group)=Name
priority The priority of the policy. Lowest number is the highest priority.

type=int
default=1
minimum=1
maximum=1000
Displayed(tab/group)=Priority
propertyClassName The full class name of the managed object.

type=string
access=read-create
minimum=3
maximum=255
Mandatory on create
Displayed(tab/group)=Object Type (/Property)
propertyName The property name of the managed object.

type=string
access=read-create
minimum=1
maximum=255
Mandatory on create
Displayed(tab/group)=Property Name (/Property)
propertyrules.PropertyValuePolicySamUser-Set type=Children-Set
propertyrules.PropertyValuePolicySamUserGroup-Set type=Children-Set
  
Properties inherited from ManagedObject
actionMask, children-Set, deploymentState, isFaultSquelched, name, objectFullName, selfAlarmed
 
Methods

assignGroups

Convenience method to perform bulk assignment of NFM-P user groups from the 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.
groupNames : List (string) - The list of NFM-P user group names to be assigned to this policy.
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false

assignUsers

Convenience method to perform bulk assignment of NFM-P users to the 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.
userNames : List (string) - The list of NFM-P user names to be assigned to this policy.
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false

unassignGroups

Convenience method to perform bulk unassignment of NFM-P user groups from the 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.
groupNames : List (string) - The list of NFM-P user group names to be unassigned from this policy.
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false

unassignUsers

Convenience method to perform bulk unassignment of NFM-P users to the 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.
userNames : List (string) - The list of NFM-P user names to be unassigned from this policy.
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false