IPPM ICMP-Echo Configuration

Configures, modifies and retrieves IPPM icmp-echo configurations. The URI to configure data for IPPM type icmp-echo is:

/ippm/config/profile/<profile-name>/icmp-echo/config

The URI to add an icmp-echo configuration in an IPPM profile using POST method is:
/ippm/config/profile/<profile-name>/icmp-echo
{
    "icx-openconfig-ippm:config": {
        "destination": "www.google.com",
        "source": "10.1.1.1",
        "ttl_max": 180,
        "ttl_min": 10,
        "rtt_max": 190,
        "rtt_min": 10,
        "jitter_max": 20,
        "probe_count": 6
}
}
The URI to add an icmp-echo configuration in an IPPM profile using PATCH method is:
ippm/config/profile/<profile-name>/icmp-echo/config
{
    "icx-openconfig-ippm:config": {
        "name": "p2",
        "destination": "www.google.com",
        "source": "10.1.1.1",
        "ttl_max": 200,
        "ttl_min": 10,
        "rtt_max": 180,
        "rtt_min": 20,
        "jitter_max": 10,
        "probe_count": 3,
        "vrf": "default-vrf",
        "schedule": {
            "date_format": "2023-11-28T12:0:0Z",
            "duration": "70",
            "frequency": "80"
        }
    }
}
The DELETE URI to delete an IPPM icmp-echo configuration is:
/ippm/config/profile/<profile-name>/icmp-echo/config

Supported HTTP Operations

GET method 

URL: https://<host>/restconf/data/ippm/config/profile/p1/icmp-echo/config
Request body: None
Response body:     
{
    "icx-openconfig-ippm:config": {
        "name": "p1",
        "destination": "10.1.1.1",
        "source": "20.1.1.1",
        "ttl_max": 100,
        "ttl_min": 10,
        "rtt_max": 120,
        "rtt_min": 30,
        "jitter_max": 10,
        "probe_count": 5,
        "vrf": "vrf1",
        "schedule": {
            "now": true,
            "infinite": true,
            "frequency": "80"
        }
    }
}

POST method

URL: https://<host>/restconf/data/ippm/config/profile/p1/icmp-echo
Request body: {
    "icx-openconfig-ippm:config": {
        "destination": "www.google.com",
        "source": "10.1.1.1",
        "ttl_max": 180,
        "ttl_min": 10,
        "rtt_max": 190,
        "rtt_min": 10,
        "jitter_max": 20,
        "probe_count": 6
}
}
Response body: None

PATCH method 

URL: https://<host>/restconf/data/ippm/config/profile/p1/icmp-echo/config
Request body:
{
    "icx-openconfig-ippm:config": {
        "name": "p2",
        "destination": "www.google.com",
        "source": "10.1.1.1",
        "ttl_max": 200,
        "ttl_min": 10,
        "rtt_max": 180,
        "rtt_min": 20,
        "jitter_max": 10,
        "probe_count": 3,
        "vrf": "default-vrf",
        "schedule": {
            "date_format": "2023-11-28T12:0:0Z",
            "duration": "70",
            "frequency": "80"
        }
    }
}

Response body: None
PUT method
URL: https://<host>/restconf/data/ippm/config/profile/p1/icmp-echo/config
Request body:
{
    "icx-openconfig-ippm:config": {
        "destination": "www.google.com",
        "ttl_max": 180,
        "ttl_min": 13,
        "rtt_max": 160     
        }
}

Response body: None
DELETE method
URL: https://<host>/restconf/data/ippm/config/profile/p1/icmp-echo/config

Request body: None
Response body: None

Parent topic: IPPM Profile