policy
Manager

A policy manager exists for each type of policy at the network and element level and contains sets of policies of a type.
Network level policy managers are named with the policyTypeManaged.
For example, Access Egress

Network element level policy managers are named with network:siteID:policyTypeManaged.
For example, network:10.1.1.88:Access Egress

policyTypeManaged is the displayed name of policy.PolicyType.



public class Manager

Properties
aaa.AcctOnOffGroup-Set type=Children-Set
aaa.IsaRadiusPolicy-Set type=Children-Set
aaa.L2tpRadiusAccountingPolicy-Set type=Children-Set
aaa.NatRadiusAccountingPolicy-Set type=Children-Set
aaa.RadiusScriptPolicy-Set type=Children-Set
aaa.RadiusServerPolicy-Set type=Children-Set
aaa.RouteDownloadPolicy-Set type=Children-Set
aapolicy.AACertProfile-Set type=Children-Set
aapolicy.AAFlowCfgPolicy-Set type=Children-Set
aapolicy.AAGroupPolicy-Set type=Children-Set
aapolicy.AAPolicer-Set type=Children-Set
aapolicy.AAPortList-Set type=Children-Set
aapolicy.AAPrefixListPolicy-Set type=Children-Set
aapolicy.AARadiusAccountingPolicy-Set type=Children-Set
aapolicy.AASessionFilter-Set type=Children-Set
aapolicy.AAUrlFilter-Set type=Children-Set
aapolicy.AAUrlListPolicy-Set type=Children-Set
aapolicy.AaCflowdGroupPolicy-Set type=Children-Set
aapolicy.AaStatTcaCfg-Set type=Children-Set
aapolicy.AaStatTcaFilterCfg-Set type=Children-Set
aapolicy.AaStatTcaFltrEntryCfg-Set type=Children-Set
aapolicy.AaStatTcaPolicerCfg-Set type=Children-Set
aapolicy.AaSubCongDetect-Set type=Children-Set
aapolicy.AaTcpValidation-Set type=Children-Set
aapolicy.AaTcpValidationTca-Set type=Children-Set
aapolicy.AccessNetworkLocation-Set type=Children-Set
aapolicy.ApplicationAssuranceControl-Set type=Children-Set
aapolicy.DnsIpCache-Set type=Children-Set
aapolicy.GtpFilter-Set type=Children-Set
aapolicy.HttpEnrich-Set type=Children-Set
aapolicy.HttpErrorRedirect-Set type=Children-Set
aapolicy.HttpNotif-Set type=Children-Set
aapolicy.HttpRedirect-Set type=Children-Set
aapolicy.Policy-Set type=Children-Set
aapolicy.SctpFilter-Set type=Children-Set
aapolicy.TetherDetection-Set type=Children-Set
aapolicy.TransitIpPolicy-Set type=Children-Set
aapolicy.TransitPrefixPolicy-Set type=Children-Set
accounting.Policy-Set type=Children-Set
aclfilter.AggregateFilter-Set type=Children-Set
aclfilter.DhcpFilter-Set type=Children-Set
aclfilter.DhcpV6Filter-Set type=Children-Set
aclfilter.GreTunnelTemplate-Set type=Children-Set
aclfilter.IpExceptionFilter-Set type=Children-Set
aclfilter.IpFilter-Set type=Children-Set
aclfilter.Ipv6ExceptionFilter-Set type=Children-Set
aclfilter.Ipv6Filter-Set type=Children-Set
aclfilter.MacFilter-Set type=Children-Set
aclfilter.VlanFilter-Set type=Children-Set
aclfilterli.BlockReservation-Set type=Children-Set
aclfilterli.LiIpFilter-Set type=Children-Set
aclfilterli.LiIpv6Filter-Set type=Children-Set
aclfilterli.LiMacFilter-Set type=Children-Set
aengr.Policy-Set type=Children-Set
aingr.Policy-Set type=Children-Set
ancp.Policy-Set type=Children-Set
aosqos.List-Set type=Children-Set
aosqos.Policy-Set type=Children-Set
aosqos.QoSAction-Set type=Children-Set
aosqos.QoSCondition-Set type=Children-Set
aosqos.QoSMacGroups-Set type=Children-Set
aosqos.QoSNetworkGroups-Set type=Children-Set
aossas.CPETestHeadGroupProfile-Set type=Children-Set
aossas.CPETestHeadProfile-Set type=Children-Set
atmpolicy.TrafficDescriptor-Set type=Children-Set
calltrace.TraceProfile-Set type=Children-Set
connprof.ConnProfPolicy-Set type=Children-Set
connprof.VlanConnProfPolicy-Set type=Children-Set
crdtctrl.CrdtCtrlPolicy-Set type=Children-Set
crdtctrl.CtgryMapPolicy-Set type=Children-Set
dctr.PortProfile-Set type=Children-Set
defaultInstanceInconsistency Use to verify the default policy instance. Currently, it is only used by the accounting policy to raise an alarm if there is more than one default policy instance for service or network types.

type=boolean
access=read-only
default=false

diameter.DiameterAppPolicy-Set type=Children-Set
diameter.DiameterPeerPolicy-Set type=Children-Set
diameter.DiameterPolicy-Set type=Children-Set
dynsvc.DynSvcLocalAuthDb-Set type=Children-Set
dynsvc.DynSvcPolicy-Set type=Children-Set
equipment.PortPolicy-Set type=Children-Set
ethernetoam.MaintenanceDomain-Set type=Children-Set
ethernetservice.CustomL2Profile-Set type=Children-Set
ethernetservice.SapProfile-Set type=Children-Set
ethernetservice.UniProfile-Set type=Children-Set
fabricqos.FabricProfile-Set type=Children-Set
file.FileTransmissionProfile-Set type=Children-Set
file.Policy-Set type=Children-Set
filterprefixlist.PortList-Set type=Children-Set
filterprefixlist.PrefixList-Set type=Children-Set
filterprefixlist.ProtocolList-Set type=Children-Set
firewall.CPMFirewall-Set type=Children-Set
firewall.HostGroup-Set type=Children-Set
firewall.MgmtAccessFirewall-Set type=Children-Set
firewall.RuleSet-Set type=Children-Set
firewall.ServiceGroup-Set type=Children-Set
firewall.Zone-Set type=Children-Set
fpresource.FPResourcePolicy-Set type=Children-Set
genericne.MVGenericPolicy-Set type=Children-Set
genericne.MvFilterPolicy-Set type=Children-Set
genericne.MvForwardingClassPolicy-Set type=Children-Set
genericne.MvMatchingRulePolicy-Set type=Children-Set
genericne.MvPolicerPolicy-Set type=Children-Set
genericne.MvQosPolicy-Set type=Children-Set
gtp.ApnPolicy-Set type=Children-Set
hsqos.HsAttachmentPolicy-Set type=Children-Set
hsqos.HsPoolPolicy-Set type=Children-Set
hsqos.HsPortPoolPolicy-Set type=Children-Set
hsqos.HsSchedulerPolicy-Set type=Children-Set
hwaggshapersched.HwAggShaperSchedulerPolicy-Set type=Children-Set
icmp.IcmpPingTemplate-Set type=Children-Set
igmp.SSMTranslatePolicy-Set type=Children-Set
ipfix.IPFIXExportPolicy-Set type=Children-Set
ipsec.CertProfile-Set type=Children-Set
ipsec.IPSecClientDB-Set type=Children-Set
ipsec.IPSecStaticSA-Set type=Children-Set
ipsec.IPSecTransform-Set type=Children-Set
ipsec.IPSecTunnelTemplate-Set type=Children-Set
ipsec.IkePolicy-Set type=Children-Set
ipsec.IkeTransform-Set type=Children-Set
ipsec.RadiusAccountingPolicy-Set type=Children-Set
ipsec.RadiusAuthenticationPolicy-Set type=Children-Set
ipsec.TrafficSelectorList-Set type=Children-Set
ipsec.TrustAnchorProfile-Set type=Children-Set
ixrqos.DSCPFCMap-Set type=Children-Set
ixrqos.Dot1pFCMap-Set type=Children-Set
ixrqos.EgressRemarkPolicy-Set type=Children-Set
ixrqos.FcDSCPMap-Set type=Children-Set
ixrqos.FcDot1pMap-Set type=Children-Set
ixrqos.FcLspExpMap-Set type=Children-Set
ixrqos.IngressClassification-Set type=Children-Set
ixrqos.LspExpFCMap-Set type=Children-Set
ixrqos.NetworkIngressPolicy-Set type=Children-Set
ixrqos.PortQosPolicy-Set type=Children-Set
ixrqos.QueueMgmtPolicy-Set type=Children-Set
ixrqos.VlanQosPolicy-Set type=Children-Set
l2fwd.MrpPolicy-Set type=Children-Set
layer2.L2Profile-Set type=Children-Set
lldp.LLDPMedNetworkPolicy-Set type=Children-Set
lldp.LLDPNetworkPolicy-Set type=Children-Set
macsec.MacPolicy-Set type=Children-Set
mpls.LspTemplateMvpn-Set type=Children-Set
mpls.Policy-Set type=Children-Set
mpls.SRLGStaticConfig-Set type=Children-Set
mpls.SharedRiskLinkGroup-Set type=Children-Set
mplstp.BFDTemplate-Set type=Children-Set
mpr.GneRadiusQosPolicy-Set type=Children-Set
mpr.QueueMapPolicy-Set type=Children-Set
mpr.RadioQOS-Set type=Children-Set
msappolicy.Policy-Set type=Children-Set
multicast.EgressMcastGroup-Set type=Children-Set
multicast.IngrPathMgmtBwPolicy-Set type=Children-Set
multicast.IngrPathMgmtInfoPolicy-Set type=Children-Set
multicast.McastCacInterfacePolicy-Set type=Children-Set
multicast.McastCacPolicy-Set type=Children-Set
multicast.McastReportDestination-Set type=Children-Set
multicast.PackagePolicy-Set type=Children-Set
nat.FirewallPolicy-Set type=Children-Set
nat.MapDomain-Set type=Children-Set
nat.NatClassifier-Set type=Children-Set
nat.NatPolicy-Set type=Children-Set
nat.NatPrefixList-Set type=Children-Set
nat.PcpPolicy-Set type=Children-Set
nat.SvcChainEvpnPolicy-Set type=Children-Set
nat.SvcChainVasFilterPolicy-Set type=Children-Set
nat.UpnpPolicy-Set type=Children-Set
niegr.Policy-Set type=Children-Set
nodelog.FilterLog-Set type=Children-Set
nodelog.FirewallLog-Set type=Children-Set
nodelog.LogFilter-Set type=Children-Set
nodelog.LogIdProfile-Set type=Children-Set
nodelog.LogProfile-Set type=Children-Set
nodelog.SecurityLog-Set type=Children-Set
nodelog.SysLogTarget-Set type=Children-Set
nodelogli.LiLogIdProfile-Set type=Children-Set
nqueue.Policy-Set type=Children-Set
pae802_1x.RadiusServerPolicy-Set type=Children-Set
pdnprofile.PacketDataNetworkProfilePolicy-Set type=Children-Set
policing.PolicerControl-Set type=Children-Set
policy.AuditStatus-Set type=Children-Set
portscheduler.HsmdaSchedulerPolicy-Set type=Children-Set
portscheduler.HsmdaWrrPolicy-Set type=Children-Set
portscheduler.Policy-Set type=Children-Set
postpolicermapping.PostPolicerMappingPolicy-Set type=Children-Set
pppoe.PPPPolicy-Set type=Children-Set
qgroup.EgressQGroupPolicy-Set type=Children-Set
qgroup.IngressQGroupPolicy-Set type=Children-Set
qgroup.RedirectList-Set type=Children-Set
qosportlist.PortList-Set type=Children-Set
qosprefixlist.PrefixList-Set type=Children-Set
qosprofile.McfrEgressQosProfile-Set type=Children-Set
qosprofile.McfrIngressQosProfile-Set type=Children-Set
qosprofile.MlpppEgressQosProfile-Set type=Children-Set
qosprofile.MlpppIngressQosProfile-Set type=Children-Set
radiusaccounting.Policy-Set type=Children-Set
redirectfilter.RedirectPolicy-Set type=Children-Set
redirectfilter.RedirectPolicyBinding-Set type=Children-Set
ressubscr.BgpPeeringPolicy-Set type=Children-Set
ressubscr.BrgProfile-Set type=Children-Set
ressubscr.HostLockoutPolicy-Set type=Children-Set
ressubscr.HostTrackingPolicy-Set type=Children-Set
ressubscr.HttpRedirectPolicy-Set type=Children-Set
ressubscr.IgmpPolicy-Set type=Children-Set
ressubscr.IpoePolicy-Set type=Children-Set
ressubscr.MldPolicy-Set type=Children-Set
ressubscr.PimPolicy-Set type=Children-Set
ressubscr.RipPolicy-Set type=Children-Set
ressubscr.ShcvPolicy-Set type=Children-Set
ressubscr.SubMcastCacPolicy-Set type=Children-Set
rmon.RemoteNetworkMonitoring-Set type=Children-Set
rp.ASPath-Set type=Children-Set
rp.ASPathGroup-Set type=Children-Set
rp.AdminGroupPolicy-Set type=Children-Set
rp.Community-Set type=Children-Set
rp.Damping-Set type=Children-Set
rp.GlobalVariables-Set type=Children-Set
rp.PolicyAccountingTemplate-Set type=Children-Set
rp.PolicyStatement-Set type=Children-Set
rp.PrefixList-Set type=Children-Set
rp.RouteDistinguisher-Set type=Children-Set
rp.RouteNextHopPolicyTemplate-Set type=Children-Set
rp.SrlgGroupPolicy-Set type=Children-Set
rp.TransactionObject-Set type=Children-Set
rp.TransactionObjectRouteNextHop-Set type=Children-Set
rtr.AdminGroupPolicy-Set type=Children-Set
rtr.AdminTag-Set type=Children-Set
rtr.AdminTagPolicy-Set type=Children-Set
rtr.ReassemblyProfilePolicy-Set type=Children-Set
rtr.RouteNextHopPolicyTemplate-Set type=Children-Set
rtr.SegmentRoutingMaintenancePolicy-Set type=Children-Set
rtr.SharedRiskLinkGroup-Set type=Children-Set
rtr.TransactionObject-Set type=Children-Set
sas.BinGroup-Set type=Children-Set
sas.LinkMeasurementTemplate-Set type=Children-Set
sas.StreamingDelayTemplate-Set type=Children-Set
sasqos.AccessEgress-Set type=Children-Set
sasqos.AccessIngress-Set type=Children-Set
sasqos.DSCPClassification-Set type=Children-Set
sasqos.Dot1pClassification-Set type=Children-Set
sasqos.EgressRemarking-Set type=Children-Set
sasqos.FCMeterMap-Set type=Children-Set
sasqos.FcDot1pMap-Set type=Children-Set
sasqos.FcDscpMap-Set type=Children-Set
sasqos.FcLspExpMap-Set type=Children-Set
sasqos.IngressCoSClassification-Set type=Children-Set
sasqos.MpBwPolicy-Set type=Children-Set
sasqos.MplsLspExpClassification-Set type=Children-Set
sasqos.MplsLspExpMap-Set type=Children-Set
sasqos.NQueue-Set type=Children-Set
sasqos.Network-Set type=Children-Set
sasqos.NetworkIngress-Set type=Children-Set
sasqos.PortAccessEgress-Set type=Children-Set
sasqos.PortAccessIngress-Set type=Children-Set
sasqos.PortScheduler-Set type=Children-Set
sasqos.QueueMgmtPolicy-Set type=Children-Set
sasqos.Remark-Set type=Children-Set
sasqos.SchedulerPolicy-Set type=Children-Set
sasqos.SlopePolicy-Set type=Children-Set
sasqos.SystemResourceProfilePolicy-Set type=Children-Set
schedule.AuditScheduledTaskResults-Set type=Children-Set
security.KeyChain-Set type=Children-Set
securitypolicy.AppGroup-Set type=Children-Set
securitypolicy.Bypass-Set type=Children-Set
securitypolicy.HostGroup-Set type=Children-Set
securitypolicy.PolicerGroup-Set type=Children-Set
securitypolicy.Policy-Set type=Children-Set
securitypolicy.Profile-Set type=Children-Set
securitypolicy.TransactionObject-Set type=Children-Set
securitypolicy.Zone-Set type=Children-Set
securityqueue.SecurityQueuePolicy-Set type=Children-Set
service.EpipeSapTemplate-Set type=Children-Set
service.SvcActTestHeadAcceptanceCriteriaTemplate-Set type=Children-Set
service.SvcActTestHeadFrameSizeTemplate-Set type=Children-Set
service.VplsSapTemplate-Set type=Children-Set
service.Y1564AcceptanceCriteriaProfile-Set type=Children-Set
service.Y1564FrameMixProfile-Set type=Children-Set
service.Y1564PayloadProfile-Set type=Children-Set
service.Y1564TestHeadProfile-Set type=Children-Set
shaperqos.ShaperPolicy-Set type=Children-Set
sharedpolicer.SharedPolicer-Set type=Children-Set
sitesec.AOSSecurityPolicy-Set type=Children-Set
sitesec.CertificateAuthProfile-Set type=Children-Set
sitesec.CertificateAutoUpdate-Set type=Children-Set
sitesec.CertificateUpdateProfile-Set type=Children-Set
sitesec.CpmIpFilter-Set type=Children-Set
sitesec.DCpuProtection-Set type=Children-Set
sitesec.DoSProtection-Set type=Children-Set
sitesec.EstAuthProfile-Set type=Children-Set
sitesec.LdapPolicy-Set type=Children-Set
sitesec.LocalUser-Set type=Children-Set
sitesec.ManagementAccessFilter-Set type=Children-Set
sitesec.PasswordPolicy-Set type=Children-Set
sitesec.PkiCommonNameList-Set type=Children-Set
sitesec.RadiusPolicy-Set type=Children-Set
sitesec.TacacsPolicy-Set type=Children-Set
sitesec.TlsCertificateProfile-Set type=Children-Set
sitesec.TlsClientCipherList-Set type=Children-Set
sitesec.TlsClientGroupList-Set type=Children-Set
sitesec.TlsClientProfile-Set type=Children-Set
sitesec.TlsClientSignatureList-Set type=Children-Set
sitesec.TlsServerCipherList-Set type=Children-Set
sitesec.TlsServerGroupList-Set type=Children-Set
sitesec.TlsServerProfile-Set type=Children-Set
sitesec.TlsServerSignatureList-Set type=Children-Set
sitesec.TlsTrustAnchorProfile-Set type=Children-Set
sitesec.UserProfile-Set type=Children-Set
slaprofile.Policy-Set type=Children-Set
slope.HsmdaPoolPolicy-Set type=Children-Set
slope.HsmdaSlopePolicy-Set type=Children-Set
slope.NamedPool-Set type=Children-Set
slope.Policy-Set type=Children-Set
squeue.Policy-Set type=Children-Set
srpythonmgmt.PythonPolicy-Set type=Children-Set
srpythonmgmt.PythonScript-Set type=Children-Set
subscrauth.Policy-Set type=Children-Set
subscrexpmap.Policy-Set type=Children-Set
subscrident.Policy-Set type=Children-Set
subscrprofile.Policy-Set type=Children-Set
svt.PwTemplate-Set type=Children-Set
svt.TunnelAdminGroup-Set type=Children-Set
sw.SoftwareRepositoryPolicy-Set type=Children-Set
tod.Policy-Set type=Children-Set
todsuite.Policy-Set type=Children-Set
unpprofile.UNPProfile-Set type=Children-Set
vrrp.Policy-Set type=Children-Set
vs.AdvancedConfigPolicy-Set type=Children-Set
vs.Policy-Set type=Children-Set
vs.ServiceTypeDefinition-Set type=Children-Set
wlangw.DsmIpFilterPolicy-Set type=Children-Set
wlangw.DsmTrafficPolicer-Set type=Children-Set
wlangw.MgwProfile-Set type=Children-Set
  
Properties inherited from policy.AbstractManager
policyTypeManaged
 
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

audit

Compare the configurable properties between the global policy and its local definitions for all the policy types. An alarm is raised for each local definition if any difference is found.
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

auditLocalPolicy

Compare the differences between two local policies or between the local and global policy.
Input Parameters:
comparingPolicyObjectFullName : string - The object full name of one of the local policy.
comparedPolicySiteId : string - The siteId of second local policy. Empty string or "0.0.0.0" means the global policy.
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:
auditLocalPolicyResult : policy.AuditLocalPolicyResultInfo - The struct shows the list of properties which are different between two local policies or between the local and global policy.

auditLocalPolicyWithInApplicableAttributeOption

Compare the differences between two local policies or between the local and global policy.
Input Parameters:
comparingPolicyObjectFullName : string - The object full name of one of the local policy.
comparedPolicySiteId : string - The siteId of second local policy. Empty string or "0.0.0.0" means the global policy.
includeInapplicableAttributes : boolean - True if inapplicable attributes needs to be considered during audit, else false.
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:
auditLocalPolicyResult : policy.AuditLocalPolicyResultInfo - The struct shows the list of properties which are different between two local policies or between the local and global policy.

auditPolicies

Compare the configurable properties between the global policy and its local definitions for the policy types or global policies specified in selectedPoliciesInfo. An alarm is raised for each local definition if any difference is found.
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.
selectedPoliciesInfo : policy.AuditSelectedPoliciesInfo - The struct to specify the policies to be audited. The selectedPolicies allows the user to specify on which policy types to perform the audit. The types are defined in policy.PolicyAuditType. The alarmAllDifferences indicates if the inapplicable entries and attributes should be compared. The globalPoliciesNames allows the user to specify the global policy names to be audited. It takes precedence over selectedPolicies. If both selectedPolicies and globalPoliciesNames are empty, all the global policies are audited on the selected NEs. The selectedNEList is the list of siteIds on which selected policy types or global policies are audited. If selectedNEList is empty, policies are audited on all the NEs.
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false

checkBulkDistributeWithinCapacity

This method is used when multiple policies are selected for distribution. It checks if the number of tasks created for bulk policy distribution is within configured capacity.
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.
instanceNames : List (string) - List of policy instance names to be distributed.
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Output Parameters:
isDistributable : boolean - True if the number of tasks is within configured maximum, false otherwise.

copyMovePolicyEntries

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.
selectedPolicyEntries : List (Pointer) - List of policy entries that need to copied or overridden for a given policy list.
policyInfoList : List (Pointer) - List of global policies to which the selected policy Entries will be copied/overridden.
entryOverride : boolean - Indicates if any existing entries in a given policy can be overridden with selected entries.
globalPolicyDistribute : boolean - Indicates if the global policy needs to be distributed post copy operation.
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Exceptions:
policy.Manager.copyMovePolicyEntriesException

deleteExportedFile

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.
exportedFileName : string - Indicates the exported file name present on the server that needs to be deleted.
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Exceptions:
policy.Manager.deleteExportedFileException

exportPolicies

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.
selectedGlobalPolicies : List (Pointer) - List of global policies that needs to be exported to an xml file.
exportFileName : string - Indicates the xml file name in which the selected global policies in NFM-P will be exported too.
description : string - This can be used to denote user description before executing the export operation.
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Exceptions:
policy.Manager.exportPoliciesException

findExportPolicyFileInfo

Finds all exported policy file names for a given policy class, along with its description and exported NFM-P version.
Input Parameters:
policyClassName : string - Indicates the class name of the policy based on which Exported Policy File List is filtered.
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:
exportPolicyFileList : Set (policy.ExportPolicyFileInfo) -

findPolicy

Finds all policies managed by this instance of policy manager and passing the filter specified as parameter. If a policy type is not supported on a Network Element the policy manager of that type may not exist on that Network Element. In this case this method will throw an 'object not found' exception because the policy manager was not found. One can use the method 'findPolicyOfType' as an alternative in this case.
Input Parameters:
instanceFullName : string - the full name of the object.
filter : FilterHolder -
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) -

findPolicyOfType

Finds all policies of a given policy type and passing the filter specified as parameter. This is a class-level method and does not require that the given policy manager should exist. If the policy manager does not exist this method will simply return an empty list.
Input Parameters:
policyType : policy.PolicyType -
filter : FilterHolder -
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) -

getAuditStatus

Return the summary of AuditStatus object (see AuditStatus for the details).
Input Parameters:
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:
auditStatus : summary(policy.AuditStatus) -

importPolicies

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.
importFileName : string - Indicates the xml file name from which the global policies would be created in NFM-P.
overrideExistingGlobalPolicy : boolean - Indicates if the global policy already exists in NFM-P, then, should it overridden with the imported global policy or not.
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:
importGlobalPoliciesSet : Set (policy.ImportGlobalPolicyResultInfo) -
Exceptions:
policy.Manager.importPoliciesException

interruptAudit

Stop the current policy audit.
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.
startNew : boolean - Indicate if the new audit should be started.
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false

previewPolicyList

Input Parameters:
importFileName : string - Indicates the xml file name in which policies need to be perused.
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:
fetchGlobalPolicyList : Set (policy.FetchGlobalPolicyInfo) -
Exceptions:
policy.Manager.previewPolicyListException