Overview Package Class Deprecated Help

generic
GenericObject

The GenericObject Class defines several methods for accessing and manipulating objects.
See also the general methods/types for methods used to manage objects.

public abstract class GenericObject

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

clearDeployer

To clear the deployer with the specified deployer name.
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.
deployerName : string - Specifies the deployer name to be used for the operation.
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false

compareObjects

Performs a comparison starting at the 2 given objects. The two objects must support object comparison and be compatible, otherwise an exception is thrown.
Input Parameters:
comparisonFilter : generic.ComparisonFilter - Used to reduce the scope of the comparison.
compareStarter : Pointer - (Optional) The compare starter object that is implementing the StructCompareStartIf which, starts the comparison between the base and compareTo. CompareStrater is only used when comparing structs and is not used when comparing managed objects.
base : Pointer - The base of the comparison.
compareTo : Pointer - The base is being compared to this 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.CompareResult - The results of the comparison.

configureChildInstance

Creates a child of the object with the desired configuration values for the child or children objects, and optional grandchildren.
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.
distinguishedName : Pointer - Distinguished Name of parent under which object is being configured.
childConfigInfo : generic.CommonManagedContainmentEntityConfigurationInformation - Desired values to configure child (and optional grandchildren) to.
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Output Parameters:
childDistinguishedName : string - Returns fullname of the child created.
Exceptions:
generic.GenericObject.configureChildInstanceException

configureChildInstanceWithResult

Creates a child of an existing object. The method returns the newly configured parameters on the child object and grandchildren, including parameters set due to associated conditions.
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.
distinguishedName : Pointer - Distinguished Name of parent under which object is being configured.
childConfigInfo : generic.CommonManagedContainmentEntityConfigurationInformation - Desired values to configure child (and optional grandchildren) to.
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:
childConfigInfo : generic.CommonManagedEntityInformation - Resulting child object (grandchildren included, if applicable). Note that some classes do not return children. In such cases, this is specified in the class documentation.
Exceptions:
generic.GenericObject.configureChildInstanceWithResultException

configureInstance

Hierarchical administrative configuration/modification of a single object instance.
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.
distinguishedName : Pointer - Distinguished Name of object being configured.
configInfo : generic.CommonManagedContainmentEntityConfigurationInformation - Desired values to configure object (and optionally children) to.
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Exceptions:
generic.GenericObject.configureInstanceException

configureInstanceWithResult

Modifies an existing object and associated children. The method returns the newly configured parameters on the object and child, including parameters set due to associated conditions.
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.
distinguishedName : Pointer - Distinguished Name of object being configured.
configInfo : generic.CommonManagedContainmentEntityConfigurationInformation - Desired values to configure object (and optionally children) to.
includeChildren : boolean - If false, only the resulting object will be returned from call. If true, resulting object and all children will be returned. Note that some classes do not return children. In such cases, this is specified in the class documentation.
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:
configInfo : generic.CommonManagedEntityInformation - Resulting object (children included, if requested, unless otherwise specified for this class in XML Reference).
Exceptions:
generic.GenericObject.configureInstanceWithResultException

configureMultipleInstances

Hierarchical administrative configuration/modification of multiple object instances. If you use this method then you need to make sure that all objects are configured then continuing doing other tasks.
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.
configInfoList : List (generic.ContainmentConfigInfoStruct) - List of structure containing the distinguished name of object being configured and the desired values to configure object (and optionally children) to.
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Exceptions:
generic.GenericObject.configureMultipleInstancesException

countInstance

Count the number of matched instances of a persisted class.
Input Parameters:
fullClassName : string - The full name of the object.
filter : FilterHolder - Additional filter that can be specified on the instance.
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Output Parameters:
result : int - Returns the number of instances.
Exceptions:
generic.GenericObject.countInstanceException

deleteInstance

This method triggers removal of an existing object. Removal of struct objects stored in auxiliary database is not supported.
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.
distinguishedName : Pointer - The name of the object that has to be deleted.
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Exceptions:
generic.GenericObject.deleteInstanceException

expandChildren

DEPRECATED - 9.0
Use generic.GenericObject.findInstance() instead.
Input Parameters:
parentDn : string - Hierarchical distinguished name of the parent object whose children are to be retrieved.
forceAllChildrenToBeExpanded : boolean - Forces entire hierarchy to be expanded ignoring children directives.
filter : FilterHolder - (Optional) Optional filter to apply to children classes to be retrieved.
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 : List (generic.CommonManagedEntityInformation) - Children hierarchy.

expandSelectedChild

DEPRECATED - 9.0
Use generic.GenericObject.findInstance() instead.
Input Parameters:
parentDn : string - Hierarchical distinguished name of the parent object whose children are to be retrieved.
filter : FilterHolder - Filter on properties of the direct child class of the parent.
expandChild : boolean - Flag to determine whether or not retrieved child should be expanded. If true, the child will be expanded, otherwise only the child will be returned.
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 : List (generic.CommonManagedEntityInformation) - Children hierarchy.

filteredDelete

This method triggers removal of all objects of given class matching the specified filter criteria. This method should be used with caution. The filter must be carefully constructed to match the intended objects. Removal of struct objects stored in auxiliary database is not supported.
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.
fullClassName : string - Package qualified class name in dot separated format. EXAMPLE: svc.Service rtr.NetworkInterface.
filter : FilterHolder - Filter on properties of the class corresponding to fully qualified class name passed in.
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Exceptions:
generic.GenericObject.filteredDeleteException

filteredFind

Retrieve a set of matched object(s) with the given instance full name and/or its children. Depending on the scope, the set could contain one object or the whole subtree.
Input Parameters:
instanceFullName : Pointer - The instance full name from the matched objects have to be retrieved.
filter : FilterHolder - The filter to be applied to the find the matched objects.
scopeType : int - Scope type. Possible values - 0 (Single Object), 1 (Single Level), 2 (N_Levels, where N = scopeDepth), 3 (Whole Subtree)
scopeDepth : int - The number of levels to be searched.
capabillities : Set (int) - Capability ID(s).
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 : List (generic.CommonManagedEntityInformation) - List of matched objects returned.
Exceptions:
generic.GenericObject.filteredFindException

findInstance

Find the instance with the given full name.
Input Parameters:
instanceFullName : Pointer - The full name of the object whose instance is to be retrieved.
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 - Returns the instance.
Exceptions:
generic.GenericObject.findInstanceException

findMultipleFilteredInstances

DEPRECATED - 9.0
Use generic.GenericObject.multipleFilteredFind() instead.
Input Parameters:
instanceFullNames : List (string) - The full names of the objects whose instances have to be retrieved.
filter : FilterHolder - The filter to be applied to find the list of 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:
result : List (generic.CommonManagedEntityInformation) - The list of objects. Note that some classes do not return children. In such cases, this is specified in the class documentation.
Exceptions:
generic.GenericObject.findMultipleFilteredInstancesException

findMultipleInstances

To find multiple instances with children hierarchy under each instance. An exception log message is recorded in the server log file for any objects, that cannot be found for specified instance names.
Input Parameters:
instanceNames : Set (Pointer) - List of instance names.
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 : List (generic.CommonManagedEntityInformation) - List of instances. Note that some classes do not return children. In such cases, this is specified in the class documentation.
Exceptions:
generic.GenericObject.findMultipleInstancesException

findMultipleInstancesShallow

To find multiple instances without children hierarchy under each instance.
Input Parameters:
instanceNames : Set (Pointer) - List of instance names.
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 : List (generic.CommonManagedEntityInformation) - list of instances.
Exceptions:
generic.GenericObject.findMultipleInstancesShallowException

forceSubmitDeployer

Tries to redeploy the object if the deployment of the object failed.
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.
deployerName : string - Specifies the deployer name to be used for the operation.
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false

getDeployer

Find information about a specific deployer.
Input Parameters:
deployerName : string - The name of the deployer to be retrieved.
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:
deployer : generic.DeployerInfo - Returns the deployer object.

getDeployers

Find information for deployers matching the specified filter with children hierarchy.
Input Parameters:
filter : FilterHolder - The filter to applied to retrieve the deployers.
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:
deployers : List (generic.DeployerInfo) - Returns the list of deployers.

getDeployersShallow

Retrieve matched deployers without children hierarchy.
Input Parameters:
filter : FilterHolder - The filter to applied to retrieve the deployers.
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:
deployers : List (generic.DeployerInfo) - Returns the list of deployers.

getIncrementalRequestID

Input Parameters:
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Output Parameters:
incrementalRequestId : long -

getProperty

DEPRECATED - 9.0
Use generic.GenericObject.findInstance() instead.
Input Parameters:
instanceFullName : Pointer - Full name of the object whose property values have to be retrieved.
propertyNameSet : Set (string) - List of property names whose values have to be retrieved.
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Output Parameters:
result : Map (string to Any) - List of property name and value pairs retrieved.
Exceptions:
generic.GenericObject.getPropertyException

multipleFilteredFind

Retrieve a set of objects matching the specified search criteria with children hierarchy.
Input Parameters:
searchCriteria : Set (generic.InstanceSearchCriteria) - The search criteria to applied to retrieve the set of objects.
capabillities : Set (int) - Capability ID(s).
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 : List (generic.CommonManagedEntityInformation) - List of objects retrieved.
Exceptions:
generic.GenericObject.multipleFilteredFindException

removeMany

This method triggers removal of a list of objects of any class type. A log message is recorded in the server log file for any objects that cannot be found for specified full names, or for struct objects stored in auxiliary database for which removal operation is not supported.
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.
objectFullNameList : List (Pointer) - List of objects to be removed.
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Exceptions:
generic.GenericObject.removeManyException

resumeDeploymentRetries

This method set deployment retry state back to true.
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.
deployerName : string - Specifies the deployer name to be used for the operation.
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false

setProperty

DEPRECATED - 9.0
Use generic.GenericObject.configureInstance() instead.
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 : Pointer - The object which contains the property that has to be set.
propertyNameValueMap : Map (string to Any) - List of property name and value pairs to be set.
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Output Parameters:
result : Map (string to Any) - Returns the list of property name and value pairs that have been set.
Exceptions:
generic.GenericObject.setPropertyException

suspendDeploymentRetries

This method set deployment retry state to false.
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.
deployerName : string - Specifies the deployer name to be used for the operation.
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false

triggerCollect

Triggers the collection of statistics on the given object.
Input Parameters:
instanceNames : Set (string) - The object instances (FDNs) to collect statistics on.
currentDataClasses : Set (string) - The statistics 'current data' classes to collect for.
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false

triggerIncrementalRequest

This method starts a request for a specified application. IncrementalRequestEvents are generated for start, incremental, failed and finished states.
Input Parameters:
aInIncrementalContext : generic.IncrementalContext - The application specific configuration is passed with this parameter.
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Output Parameters:
incrementalRequestId : long - The incremental request ID is returned when the request is started. The ID can be used to identify IncrementalRequestEvents for this request.

triggerIncrementalRequestWithRequestID

This method starts a request using known requestID for a specified application. The requestID is getting from method getIncrementalRequestID. IncrementalRequestEvents are generated for start, incremental, failed and finished states.
Input Parameters:
aInIncrementalRequestId : long - The incremental request ID is returned when the request is started. The ID can be used to identify IncrementalRequestEvents for this request.
aInIncrementalContext : generic.IncrementalContext - The application specific configuration is passed with this parameter.
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false

triggerResync

To perform a non-scheduled resynchronization of an object. The resynch request will not return until all related resync tasks have completed.
Input Parameters:
instanceName : Pointer - The name of the instance to be resynched.
resyncSelf : boolean - Specifies if the object has to be resynched.
resyncChildren : boolean - Specifies if children need to be resynched.
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Output Parameters:
resyncStatus : int - Resulting status of the resync, as defined in taskmgmt.TaskStatus

updateUserObjectLifecycleStates

Set user OLC States.
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.
distinguishedName : Pointer - Distinguished Name of object being configured.
anInOLCState : int -
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Output Parameters:
anOutOLCState : int -
Exceptions:
generic.GenericObject.updateUserObjectLifecycleStatesException

updateUserObjectLifecycleStatesAndLocks

Set user OLC States.
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.
distinguishedName : Pointer - Distinguished Name of object being configured.
anInOLCState : int - The target OLC State.
anInLockOLCState : boolean - The target Lock OLC State.
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Output Parameters:
anOutOLCState : int -
Exceptions:
generic.GenericObject.updateUserObjectLifecycleStatesAndLocksException

updateUserObjectLifecycleStatesAndLocksAndSchedules

Set user OLC Schedule.
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.
distinguishedName : Pointer - Distinguished Name of object being configured.
anInFlipTimeSelected : long - The time in milliseconds that OLC State will be flipped.
anInCurrentOLCState : int - The target OLC State to set before the schedule.
anInCurrentLockOLCState : boolean - The target Lock OLC State to set before the schedule.
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Output Parameters:
anOutOLCFlipTimeSelected : long -
Exceptions:
generic.GenericObject.updateUserObjectLifecycleStatesAndLocksAndSchedulesException

updateUserObjectLifecycleStatesAndSchedules

Set user OLC Schedule.
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.
distinguishedName : Pointer - Distinguished Name of object being configured.
anInFlipTimeSelected : long - The time in milliseconds that OLC State will be flipped.
anInCurrentOLCState : int - The target OLC State to set before the schedule.
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Output Parameters:
anOutOLCFlipTimeSelected : long -
Exceptions:
generic.GenericObject.updateUserObjectLifecycleStatesAndSchedulesException