sas
TestPolicy

A SAS test policy is a set of test definitions, pre-processing and post-processing rules, and execution strategies.



public class TestPolicy

Properties
accountingFiles Specifies whether this test suite uses SAA Accounting

type=boolean
default=false
Displayed(tab/group)=Accounting Files (/Test Results)

ancp.AncpLoopbackDefinition-Set type=Children-Set
atm.AtmPingDefinition-Set type=Children-Set
bier.BierPingDefinition-Set type=Children-Set
bier.BierTraceDefinition-Set type=Children-Set
bypassRouting The value of bypassRouting specifies whether or not to send the ping request (for an IP test which belongs to the specified session) to a host on a directly attached network, bypassing the routing table.

type=boolean
default=false
Displayed(tab/group)=Bypass Routing (/IP Session Configuration)

contExecution Specifies whether this test suite is currently being continuously executed by the node

type=boolean
default=false
Displayed(tab/group)=Continuously Executed (/Test Results)

contextTestSuite OAM Context Test Suite.

type=string
default=

description The description of the test. Not interpreted by NFM-P.

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

destUDPPort Specifies destination UDP Port

type=int
default=64364
minimum=0
maximum=65535
Displayed(tab/group)=Preferred Destination UDP Port (/IP Session Configuration)

displayedName The display name of the test. Not interpreted by NFM-P.

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

doNotFragment The value of doNotFragment specifies whether or not the IPv4 Don't Fragment (DF) bit is set in each echo request packet launched for each test belonging to the specified session.

type=boolean
default=false
Displayed(tab/group)=Do Not Fragment (/IP Session Configuration)

dscpEgressRemark The value of dscpEgressRemark specifies whether or not to allow each echo request packet's IP header Differentiated Services Code Point (DSCP) to be overwritten in accordance with the egress port's Quality of Service (QoS) policy. The echo request packets are launched for each test belonging to the specified session.

type=boolean
default=false
Displayed(tab/group)=DSCP Egress Remark (/IP Session Configuration)

dscpName The value of dscpName specifies the Differentiated Services Code Point (DSCP) to be copied into the IP header of each echo request packet launched for each test belonging to the specified session.

type=sas.DscpEnum
default=0
Displayed(tab/group)=DSCP Name (/IP Session Configuration), DSCP Name (/MPLS Details)

enableMplsDmOnSourceAndDest Setting this to true causes the source and target node's MplsDmConfig.adminStatus fields to get set upon test execution.

type=boolean
default=false
Displayed(tab/group)=Force Enable MPLS-DM (/MPLS Details)

ethernetoam.CfmDmmSessionDefinition-Set type=Children-Set
ethernetoam.CfmEthTestDefinition-Set type=Children-Set
ethernetoam.CfmLinkTraceDefinition-Set type=Children-Set
ethernetoam.CfmLmmSessionDefinition-Set type=Children-Set
ethernetoam.CfmLoopbackDefinition-Set type=Children-Set
ethernetoam.CfmOneWayDelayTestDefinition-Set type=Children-Set
ethernetoam.CfmSingleEndedLossTestDefinition-Set type=Children-Set
ethernetoam.CfmSlmSessionDefinition-Set type=Children-Set
ethernetoam.CfmTwoWayDelayTestDefinition-Set type=Children-Set
ethernetoam.CfmTwoWaySlmDefinition-Set type=Children-Set
executionSequence Specifies the policy used to control the order or sequence that the tests are executed in.

type=sas.ExecutionSequence
default=policySequenced

executionStrategy Specifies policy used to control the execution of tests.

type=sas.ExecutionStrategy
default=doAll

forwardingClass forwarding class

type=qos.FcEnum
default=be
Displayed(tab/group)=Forwarding Class (/IP Session Configuration), Forwarding Class (/MPLS Details)

generatedIpTypes Specifies the address type(s) for the test, to limit the number of generated tests if required.

type=sas.GenerationIpTypes
default=all
Displayed(tab/group)=Types (/Address Types)

generationStrategy Provides options to manage the number of generated tests.

type=sas.GenerationStrategy
default=all
Displayed(tab/group)=Strategy (/Test Generation)

icmp.IcmpPingDefinition-Set type=Children-Set
icmp.IcmpTraceDefinition-Set type=Children-Set
id The unique identifier of the test policy.

type=long
access=read-create
default=0
minimum=1
Displayed(tab/group)=ID

ignoreResults default="yes:false"> Specifies whether this test suite is used as an SLA tool.

DEPRECATED: 10.0 R1 - Use sas.TestDefinition.probeHistory instead.
type=boolean

ipProfile IP Profile

type=qos.Profile
default=out
Displayed(tab/group)=IP Profile (/IP Session Configuration)

lastModificationTime The timestamp of the last modification of this test policy or any of its containing test definitions.

type=Date
access=read-only
default=0
Displayed(tab/group)=Last Modified

mefMode Specifies sas test policy is supported for Performance monitoring or not.

type=boolean
default=false
Displayed(tab/group)=MEF35 Mode

mpls.LspPingDefinition-Set type=Children-Set
mpls.LspTraceDefinition-Set type=Children-Set
mpls.P2MPLspPingDefinition-Set type=Children-Set
mpls.P2MPLspTraceDefinition-Set type=Children-Set
mplsProfile Specifies the Quality of Service profile to be used when launching an MPLS Delay Measurement (DM) query for each test belonging to the specified session.

type=qos.Profile
default=out
Displayed(tab/group)=MPLS Profile (/MPLS Details)

multicast.MfibPingDefinition-Set type=Children-Set
multicast.MrinfoDefinition-Set type=Children-Set
multicast.Mtrace2Definition-Set type=Children-Set
multicast.MtraceDefinition-Set type=Children-Set
neSchedulable Specifies whether this policy may contain only all NE schedulable test definitions or no NE schedulable test definitions.

type=boolean
access=read-create
default=false
Displayed(tab/group)=NE Schedulable

oneTimeValidate Indicates that this is a default Test Policy used for one-time validation. This marks the policy as read only and not deletable.

type=boolean
access=read-only
default=false
Displayed(tab/group)=One Time Validation Default Policy

pattern The value of pattern specifies a two octet pattern to be repeated to fill the padding field of each echo request packet launched for each test belonging to the specified session. For example, if 255 is specified, the padding field is filled with the octet values 00, FF, 00, FF, ... (hexadecimal).

type=int
default=0
minimum=-1
maximum=65535
Displayed(tab/group)=Pattern (/IP Session Configuration), Pattern (/MPLS Details)

pmEthPriority pmEthPriority specifies the value to be copied into the priority field when launching a test PDU for the specified session.

type=int
default=0
minimum=0
maximum=7
Displayed(tab/group)=Eth Priority (/Session Configuration)

runFromContext Specifies whether this test suite is created from OAM Context.

type=boolean
access=read-only
default=false
Displayed(tab/group)=OAM Context Enabled

sas.BinGroupDetail-Set type=Children-Set
sas.CfmConfigDetail-Set type=Children-Set
sas.MeasurementIntervalDetail-Set type=Children-Set
sas.MplsDmSessionDefinition-Set type=Children-Set
sas.TWLSessionDefinition-Set type=Children-Set
sas.VxlanPingDefinition-Set type=Children-Set
service.MacPingDefinition-Set type=Children-Set
service.MacTraceDefinition-Set type=Children-Set
service.SitePingDefinition-Set type=Children-Set
sessionType

type=sas.TestSuiteSessionType
default=proactive
Displayed(tab/group)=Session Type (/Session Configuration), Session Type (/IP Session Configuration)

sla default="yes:false"> Specifies whether this test suite is used as an SLA tool.

DEPRECATED: 10.0 R1 - Use sas.TestDefinition.probeHistory instead.
type=boolean

svt.MtuPingDefinition-Set type=Children-Set
svt.TunnelPingDefinition-Set type=Children-Set
svt.VccvPingDefinition-Set type=Children-Set
svt.VccvTraceDefinition-Set type=Children-Set
testFamily Specifies the test family. IP for TWAMP Light; ethernet for LMM, SLM, and DMM

type=sas.TestFamily
default=ethernet
Displayed(tab/group)=Test Family

testResultStorage This value specifies whether or not the OAM NE Schedulable test results are to be logged to a file, stored in the DB, or both

type=sas.TestResultStorageEnum
default=logToDB
Displayed(tab/group)=Test Result Storage (/Test Results)

testedEntityType Specifies the policy used to control the type of objects allowed to use this test policy to test themselves.

type=sas.TestedEntityType
access=read-create
default=vll
Displayed(tab/group)=Entity Type (/Testing Policy)

ttl Time to Live

type=int
default=255
minimum=1
maximum=255
Displayed(tab/group)=Time to Live (/IP Session Configuration), Time to Live (/MPLS Details)

usePattern Specifies whether the "pattern" field should be used to specify a pattern to be repeated to fill the padding field of each echo request packet.

type=boolean
default=true
Displayed(tab/group)=Use Pattern (/IP Session Configuration), Use Pattern (/MPLS Details)

vprn.VprnPingDefinition-Set type=Children-Set
vprn.VprnTraceDefinition-Set type=Children-Set
  
Properties inherited from ManagedObject
actionMask, children-Set, deploymentState, isFaultSquelched, name, objectFullName, selfAlarmed
 
Methods

updateAllTestSuites

Update all test suites (bound to this test policy) based on the latest contents of this test 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
Exceptions:
sas.TestPolicy.updateAllTestSuitesException