IP SLA Creators - RESTful API

Summary:

List information about IP SLA creators that are defined for a specified device, and create an IP SLA creator for a specified device.

URL:

http(s)://{server hostname}/api/objects/{swId}/ipslaCreators

Methods summary

GET Method detail

POST Method detail

Methods summary

• GET Method - details information about IP SLA creators that are defined for the device.
• POST Method - creates an IP SLA creator.

GET Method detail

Returns detailed information about IP SLA creators defined for the device.

Response:

A list of IP SLA creators, with every entry conforming to the Request and response section of IP SLA Management.

Examples:

INPUT
curl -u admin:admin https://localhost/api/objects/600/ipslaCreators?media=json

OUTPUT
{
  "items" :
  [
    {
      "attributes" :
      {
        "failureCause" : "",
        "frequency" : "300",
        "id" : "772",
        "index" : "2",
        "lifetime" : "forever",
        "name" : "B",
        "nameserver" : "127.0.0.1",
        "tag" : "a",
        "targetAddress" : "127.0.0.1",
        "timeout" : "1000",
        "type" : "DNS",
        "vrfName" : "a"
      }
    },
  ],
  "count" : 1
}

INPUT
curl -u admin:admin https://localhost/api/objects/600/ipslaCreators?media=xml

OUTPUT
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<items count="1">
  <item xsi:type="ipslaAttributesMap" xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance">
    <attributes>
      <id>772</id>
      <type>DNS</type>
      <index>2</index>
      <name>B</name>
      <tag>a</tag>
      <lifetime>forever</lifetime>
      <frequency>300</frequency>
      <timeout>1000</timeout>
      <vrfName>a</vrfName>
      <failureCause />
      <targetAddress>127.0.0.1</targetAddress>
      <nameserver>127.0.0.1</nameserver>
    </attributes>
  </item>
</items>

POST Method detail

Creates an IP SLA creator for a particular device.

Request:

A set of attributes that define an IP SLA creator, according to the details described in the Request and response section of IP SLA Management.

Response:

An updated list of IP SLA creators, with every entry conforming to the Request and response section of IP SLA Management.

Examples:

INPUT
curl -u admin:adminhttps://localhost/api/objects/600/ipslaCreators?media=json -X POST -H "content-type:application/json" -d \
'{
  "frequency" : 500,
  "index" : 0,
  "lifetime" : 0,
  "name" : "X",
  "sourcePort" : "2555",
  "tag" : "x",
  "targetAddress" : "127.0.0.1",
  "timeout" : 1000,
  "type" : "DHCP",
  "vrfName" : "x"
}'

OUTPUT
{
  "items" : [
    {
      "attributes" : {
        "frequency" : "300",
        "id" : "772",
        "index" : "2",
        "lifetime" : "forever",
        "name" : "B",
        "nameserver" : "127.0.0.1",
        "tag" : "a",
        "targetAddress" : "127.0.0.1",
        "timeout" : "1000",
        "type" : "DNS",
        "vrfName" : "a"
      }
    }, {
      "attributes" : {
        "frequency" : "500",
        "id" : "1481",
        "index" : "0",
        "lifetime" : "0",
        "name" : "X",
        "sourceAddress" : "null",
        "sourcePort" : "2555",
        "tag" : "x",
        "targetAddress" : "127.0.0.1",
        "timeout" : "1000",
        "type" : "DHCP",
        "vrfName" : "x"
      }
    }
    ],
  "count" : 2
}

INPUT
curl -u admin:admin https://localhost/api/objects/600/ipslaCreators?media=xml -X POST -H "content-type:application/xml" -d \
'<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ipslaCreator>
  <type>DHCP</type>
  <index>0</index>
  <name>X</name>
  <tag>x</tag>
  <lifetime>0</lifetime>
  <frequency>500</frequency>
  <timeout>1000</timeout>
  <vrfName>x</vrfName>
  <targetAddress>127.0.0.1</targetAddress>
  <sourcePort>2555</sourcePort>
</ipslaCreator>'

OUTPUT
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<items count="2">
  <item xsi:type="ipslaAttributesMap" xmlns:xsi="https://www.w3.org/2001/XMLSchea-instance">
    <attributes>
      <id>772</id>
      <type>DNS</type>
      <index>2</index>
      <name>B</name>
      <tag>a</tag>
      <lifetime>forever</lifetime>
      <frequency>300</frequency>
      <timeout>1000</timeout>
      <vrfName>a</vrfName>
      <targetAddress>127.0.0.1</targetAddress>
      <nameserver>127.0.0.1</nameserver>
    </attributes>
  </item>
  <item xsi:type="ipslaAttributesMap" xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance">
    <attributes>
      <id>1481</id>
      <type>DHCP</type>
      <index>3</index>
      <name>X</name>
      <tag>x</tag>
      <lifetime>0</lifetime>
      <frequency>500</frequency>
      <timeout>1000</timeout>
      <vrfName>x</vrfName>
      <targetAddress>127.0.0.1</targetAddress>
      <sourceAddress>null</sourceAddress>
      <sourcePort>2555</sourcePort>
    </attributes>
  </item>
</items>