Resources | system | pathCheckPath

pathCheckPath

The name of the Path Check Path.

Exists on Condition /system/sbcPersonality/role !='mrfp'

Configuration

ParameterPresenceTypeDefaultDescription
nameMstring The name of this Pathcheck Path.
sourceIpAddressOip-address Source IP address of the ping path.
targetIpAddressMip-address Target IP address of the ping path.
reportSignalIpAddressMip-address Reported Signalling IP address of the ping path.
reportSignalIpPortMint32 Reported Signalling Port of the ping path.
pathCheckProfileMreference Path Check profile name used when pinging this peer
addressContextMreference Address Context where the corressponding Interface Group is present
zoneMreference Zone name used when pinging this peer
ipInterfaceGroupMreference IP Interface Group where the corressponding IP Interface is present.
ipInterfaceMreference IP interface from which ping should be generated.
stateOenumerationdisabled Defines if active pinging is enabled or disabled
REST API: GET Example

curl -kisu 'admin:secret' -X GET https://{SBX-SERVER}/api/config/system/pathCheckPath/{name}

REST API: POST Example

curl -kisu 'admin:secret' -X POST -H 'Content-Type: application/vnd.yang.data+xml' https://{SBX-SERVER}/api/config/system --data '
<pathCheckPath>
     <name>{name}</name>
     <targetIpAddress>{targetIpAddress}</targetIpAddress>
     <reportSignalIpAddress>{reportSignalIpAddress}</reportSignalIpAddress>
     <reportSignalIpPort>{reportSignalIpPort}</reportSignalIpPort>
     <pathCheckProfile>{pathCheckProfile}</pathCheckProfile>
     <addressContext>{addressContext}</addressContext>
     <zone>{zone}</zone>
     <ipInterfaceGroup>{ipInterfaceGroup}</ipInterfaceGroup>
     <ipInterface>{ipInterface}</ipInterface>
</pathCheckPath>
'

REST API: DELETE Example

curl -kisu 'admin:secret' -X DELETE https://{SBX-SERVER}/api/config/system/pathCheckPath/{name}

  • No labels