RESTCONF API Guide

AAA 22

raw

Create TACACS server using post method  |  POST   https://10.176.128.99/restconf/data/system/aaa/server-groups

Description

To create tacacs server using post method

Body
{
    "server-group": [
        {
            "name": "tacacs-default-group",
            "config": {
                "name": "tacacs-default-group",
                "type": "TACACS"
            },
            "servers": {
                "server": [
                    {
                        "address": "55.1.1.1",
                        "config": {
                            "name": "55.1.1.1",
                            "address": "55.1.1.1"
                        },
                        "tacacs": {
                            "config": {
                                "port": "1234",
                                "secret-key": "test1234"
                            }
                        }
                    }
                ]
            }
        }
    ]
}

raw

Create radius server using POST method  |  POST   https://10.176.128.99/restconf/data/system/aaa/server-groups

Description

To create radius server using POST method

Body
{
    "server-group": [
        {
            "name": "radius-default-group",
            "config": {
                "name": "radius-default-group",
                "type": "RADIUS"
            },
            "servers": {
                "server": [
                    {
                        "address": "56.1.1.1",
                        "config": {
                            "name": "56.1.1.1",
                            "address": "56.1.1.1"
                        },
                        "radius": {
                            "config": {
                                "auth-port": "1812",
                                "acct-port": "1813",
                                "secret-key": "radiust1234",
                                "retransmit-attempts": 2,
                                "icx-openconfig-aaa-aug:dot1x": true,
                                "icx-openconfig-aaa-aug:web-auth": true
                            }
                        }
                    }
                ]
            }
        }
    ]
}

raw

Create/update radius server using PATCH method  |  PATCH   https://10.176.128.99/restconf/data/system/aaa/server-groups

Description

To create/update radius server using patch method

Body
{
    "server-groups": {
        "server-group": [
            {
                "name": "radius-default-group",
                "config": {
                    "name": "radius-default-group",
                    "type": "RADIUS"
                },
                "servers": {
                    "server": [
                        {
                            "address": "58.1.1.1",
                            "config": {
                                "name": "58.1.1.1",
                                "address": "58.1.1.1"
                            },
                            "radius": {
                                "config": {
                                    "auth-port": 1812,
                                    "acct-port": 1813,
                                    "secret-key": "radiust123",
                                    "retransmit-attempts": 2
                                }
                            }
                        }
                    ]
                }
            }
        ]
    }
}

raw

Cretae/update tacacs server using PATCH method  |  PATCH   https://10.176.128.99/restconf/data/system/aaa/server-groups

Description

To create/update tacacs server using PATCH method

Body
{
    "server-groups": {
        "server-group": [
            {
                "name": "tacacs-default-group",
                "config": {
                    "name": "tacacs-default-group",
                    "type": "TACACS"
                },
                "servers": {
                    "server": [
                        {
                            "address": "57.1.1.1",
                            "config": {
                                "name": "57.1.1.1",
                                "address": "57.1.1.1"
                            },
                            "tacacs": {
                                "config": {
                                    "port": 49,
                                    "secret-key": "test1234"
                                }
                            }
                        }
                    ]
                }
            }
        ]
    }
}

Delete all tacacs/radius servers configured in the system  |  DELETE   https://10.176.128.99/restconf/data/system/aaa/server-groups

Description

To delete all tacacs/radius servers configured in the system


Delete specific radius server configured in the system  |  DELETE   https://10.176.128.99/restconf/data/system/aaa/server-groups/server-group/radius-default-group/servers/server/56.1.1.1

Description

To delete specific radius server configured in the system


Delete specific tacacs server configured in the system  |  DELETE   https://10.176.128.99/restconf/data/system/aaa/server-groups/server-group/tacacs-default-group/servers/server/55.1.1.1

Description

To delete specific tacacs server configured in the system


raw

Disable AAA authorization icx COA(change of authorization) using patch  |  PATCH   https://10.176.128.99/restconf/data/system/aaa/authorization/coa

Description

To update/disable AAA authorization icx COA(change of authorization) using patch

Body
{
    "coa": {
        "enable": "false"
    }
}

raw

Disable COA(change of Authorization) ignore options  |  PATCH   https://10.176.128.99/restconf/data/system/aaa/authorization/coa/ignore

Description

To update/disable COA ignore options

Body
{
    "ignore": {
        "flip-port": "false",
        "disable-port": "false",
        "reauth-host": "false",
        "modify-acl": "false",
        "dm-request": "false"
    }
}

raw

Disable Dot1x RADIUS authentication using PATCH  |  PATCH   https://10.176.128.99/restconf/data/system/aaa/authentication

Description

To update/disable Dot1x RADIUS authentication using patch

Body
{
    "authentication": {
        "icx-openconfig-aaa-aug:dot1x": {
            "default": "none"
        }
    }
}

raw

Enable AAA authorization icx COA(change of Authorization) using patch  |  PATCH   https://10.176.128.99/restconf/data/system/aaa/authorization/coa

Description

To update/enable AAA authorization icx COA(change of Authorization) using patch method

Body
{
    "icx-openconfig-aaa-aug:coa": {
        "enable": "true"
    }
}

raw

Enable COA(change of Authorization) ignore options  |  PATCH   https://10.176.128.99/restconf/data/system/aaa/authorization/coa/ignore

Description

To update/enable COA ignore options

Body
{
    "ignore": {
        "flip-port": "true",
        "disable-port": "true",
        "reauth-host": "true",
        "modify-acl": "true",
        "dm-request": "true"
    }
}

raw

Enable Dot1x RADIUS authentication using PATCH  |  PATCH   https://10.176.128.99/restconf/data/system/aaa/authentication

Description

To update/enable Dot1x RADIUS authentication using patch

Body
{
    "authentication": {
        "icx-openconfig-aaa-aug:dot1x": {
            "default": "radius"
        }
    }
}

Get aaa authorization COA(change of authorization) options  |  GET   https://10.176.128.99/restconf/data/system/aaa/authorization/coa

Description

To get/read aaa authorization COA(change of authorization) options


Get all tacacs/radius servers configured in the system  |  GET   https://10.176.128.99/restconf/data/system/aaa/server-groups

Description

To get/read tacacs/radius servers configured in the system


Get default AAA configs on ICX switch  |  GET   https://10.176.128.99/restconf/data/system/aaa

Description

To read/get default AAA configs on icx switch after system boot up


Get icx dot1x authentication status  |  GET   https://10.176.128.99/restconf/data/system/aaa/authentication/dot1x

Description

To get/read dot1x authentication status


Get specific radius server configured in the system  |  GET   https://10.176.128.99/restconf/data/system/aaa/server-groups/server-group/radius-default-group/servers/server/56.1.1.1

Description

To get/read specific radius server configured in the system


Get specific tacacs server configured in the system  |  GET   https://10.176.128.99/restconf/data/system/aaa/server-groups/server-group/tacacs-default-group/servers/server/55.1.1.1

Description

To get/read specific server configured in the system


raw

Replace radius server configured in the system with new server  |  PUT   https://10.176.128.99/restconf/data/system/aaa/server-groups

Description

To replace radius server configured in the system

Body
{
    "server-groups": {
        "server-group": [
            {
                "name": "radius-default-group",
                "config": {
                    "name": "radius-default-group",
                    "type": "RADIUS"
                },
                "servers": {
                    "server": [
                        {
                            "address": "66.1.1.1",
                            "config": {
                                "name": "66.1.1.1",
                                "address": "66.1.1.1"
                            },
                            "radius": {
                                "config": {
                                    "auth-port": "1812",
                                    "acct-port": "1813",
                                    "secret-key": "radiust1234",
                                    "retransmit-attempts": 2,
                                    "icx-openconfig-aaa-aug:dot1x": true,
                                    "icx-openconfig-aaa-aug:web-auth": true
                                }
                            }
                        }
                    ]
                }
            }
        ]
    }
}

raw

Replace tacacs server configured in the system with new server  |  PUT   https://10.176.128.99/restconf/data/system/aaa/server-groups

Description

To replace tacacs server configured in the system with new server

Body
{
    "server-groups": {
        "server-group": [
            {
                "name": "tacacs-default-group",
                "config": {
                    "name": "tacacs-default-group",
                    "type": "TACACS"
                },
                "servers": {
                    "server": [
                        {
                            "address": "55.1.1.1",
                            "config": {
                                "name": "55.1.1.1",
                                "address": "55.1.1.1"
                            },
                            "tacacs": {
                                "config": {
                                    "port": "1234",
                                    "secret-key": "test1234"
                                }
                            }
                        }
                    ]
                }
            }
        ]
    }
}

raw

create/update authentication method list using patch  |  PATCH   https://10.176.128.99/restconf/data/system/aaa/authentication

Description

To create/update authentication method list using patch

Body
{
    "authentication": {
        "config": {
            "authentication-method": "TACACS_ONLY_ALL"
        }
    }
}

AAA-username 7

Delete specific AAA user  |  DELETE   https://10.176.128.99/restconf/data/system/aaa/authentication/users/user/user4

Description

To delete a specific AAA username


Get AAA usernames configured in the system  |  GET   https://10.176.128.99/restconf/data/system/aaa/authentication/users

Description

get/read AAA usernames configured in the system


Get specific username configured in the system  |  GET   https://10.176.128.99/restconf/data/system/aaa/authentication/users/user/user2

Description

To get/read specific username configured in the system


raw

To create/update AAA user using PATCH method  |  PATCH   https://10.176.128.99/restconf/data/system/aaa/authentication/users

Description

To create/update AAA user using PATCh method

Body
{
    "users": {
        "user": [
            {
                "username": "user3",
                "config": {
                    "username": "user3",
                    "password": "passwordforuser3",
                    "icx-openconfig-aaa-aug:privilege": 0
                }
            }
        ]
    }
}

raw

To create/update AAA username using PATCH method  |  PATCH   https://10.176.128.99/restconf/data/system/aaa/authentication/users

Description

To create/update AAA username using PATCH method

Body
{
    "users": {
        "user": [
            {
                "username": "user4",
                "config": {
                    "username": "user4",
                    "password": "passwordforuser4",
                    "icx-openconfig-aaa-aug:privilege": 0
                }
            }
        ]
    }
}

raw

To replace AAA user using PUT method  |  PUT   https://10.176.128.99/restconf/data/system/aaa/authentication/users

Description

To replace AAA user using PUT method

Body
{
    "users": {
        "user": [
            {
                "username": "user4",
                "config": {
                    "username": "user4",
                    "password": "passwordforuser4",
                    "icx-openconfig-aaa-aug:privilege": 0
                }
            }
        ]
    }
}

raw

create AAA username using POST method  |  POST   https://10.176.128.99/restconf/data/system/aaa/authentication/users

Description

To create AAA username using POST method

Body
{
    "user": [
        {
            "username": "user3",
            "config": {
                "username": "user3",
                "password": "passwordforuser3",
                "icx-openconfig-aaa-aug:privilege": 1
            }
        }
    ]
}

ACL 32

raw

Apply ipv4 ext acl on ingress/egress acl using POST method  |  POST   https://10.176.128.99/restconf/data/acl

Description

To apply ipv4 ext acl on ingress/egress acl using POST method

Body
{
    "interfaces": {
        "interface": [
            {
                "id": "ethernet 1/1/1",
                "config": {
                    "id": "ethernet 1/1/1"
                },
                "ingress-acl-sets": {
                    "ingress-acl-set": [
                        {
                            "set-name": "ext_acl1",
                            "type": "ACL_IPV4",
                            "config": {
                                "set-name": "ext_acl1",
                                "type": "ACL_IPV4"
                            }
                        }
                    ]
                }
            },
            {
                "id": "ethernet 1/1/2",
                "config": {
                    "id": "ethernet 1/1/2"
                },
                "egress-acl-sets": {
                    "egress-acl-set": [
                        {
                            "set-name": "ext_acl1",
                            "type": "ACL_IPV4",
                            "config": {
                                "set-name": "ext_acl1",
                                "type": "ACL_IPV4"
                            }
                        }
                    ]
                }
            }
        ]
    }
}

raw

Apply ipv4 extended acl on ingress and egress interface using PATCH  |  PATCH   https://10.176.128.99/restconf/data/acl/interfaces

Description

To apply ipv4 extended acl on ingress and egress interface using PATCH

Body
{
    "interfaces": {
        "interface": [
            {
                "id": "ethernet 1/1/1",
                "config": {
                    "id": "ethernet 1/1/1"
                },
                "ingress-acl-sets": {
                    "ingress-acl-set": [
                        {
                            "set-name": "ext_acl1",
                            "type": "ACL_IPV4",
                            "config": {
                                "set-name": "ext_acl1",
                                "type": "ACL_IPV4"
                            }
                        }
                    ]
                }
            },
            {
                "id": "ethernet 1/1/2",
                "config": {
                    "id": "ethernet 1/1/2"
                },
                "egress-acl-sets": {
                    "egress-acl-set": [
                        {
                            "set-name": "ext_acl1",
                            "type": "ACL_IPV4",
                            "config": {
                                "set-name": "ext_acl1",
                                "type": "ACL_IPV4"
                            }
                        }
                    ]
                }
            }
        ]
    }
}

raw

Apply ipv4 std acl on ingress/egress interfaces using POST method  |  POST   https://10.176.128.99/restconf/data/acl

Description

To apply ipv4 std acl on ingress/egress interfaces using POST method

Body
{
    "interfaces": {
        "interface": [
            {
                "id": "ethernet 1/1/5",
                "config": {
                    "id": "ethernet 1/1/5"
                },
                "ingress-acl-sets": {
                    "ingress-acl-set": [
                        {
                            "set-name": "ip_stan_test",
                            "type": "ACL_IPV4",
                            "config": {
                                "set-name": "ip_stan_test",
                                "type": "ACL_IPV4"
                            }
                        }
                    ]
                }
            },
            {
                "id": "ethernet 1/1/6",
                "config": {
                    "id": "ethernet 1/1/6"
                },
                "egress-acl-sets": {
                    "egress-acl-set": [
                        {
                            "set-name": "ip_stan_test",
                            "type": "ACL_IPV4",
                            "config": {
                                "set-name": "ip_stan_test",
                                "type": "ACL_IPV4"
                            }
                        }
                    ]
                }
            }
        ]
    }
}

raw

Apply mac acl(l2 acl) on ingree/egress interface using POST method  |  POST   https://10.176.128.99/restconf/data/acl

Description

To apply mac acl(l2 acl) on ingree/egress interface using POST method

Body
{
    "interfaces": {
        "interface": [
            {
                "id": "ethernet 1/1/10",
                "config": {
                    "id": "ethernet 1/1/10"
                },
                "ingress-acl-sets": {
                    "ingress-acl-set": [
                        {
                            "set-name": "bj5",
                            "type": "ACL_L2",
                            "config": {
                                "set-name": "bj5",
                                "type": "ACL_L2"
                            }
                        }
                    ]
                }
            },
            {
                "id": "ethernet 1/1/11",
                "config": {
                    "id": "ethernet 1/1/11"
                },
                "egress-acl-sets": {
                    "egress-acl-set": [
                        {
                            "set-name": "bj5",
                            "type": "ACL_L2",
                            "config": {
                                "set-name": "bj5",
                                "type": "ACL_L2"
                            }
                        }
                    ]
                }
            }
        ]
    }
}

raw

Apply/update ipv4 std acl on ingress and egress interface using PATCH  |  PATCH   https://10.176.128.99/restconf/data/acl/interfaces

Description

To apply/update ipv4 std acl on ingress and egress interface using PATCH method

Body
{
    "interfaces": {
        "interface": [
            {
                "id": "ethernet 1/1/5",
                "config": {
                    "id": "ethernet 1/1/5"
                },
                "ingress-acl-sets": {
                    "ingress-acl-set": [
                        {
                            "set-name": "ip_stan_test",
                            "type": "ACL_IPV4",
                            "config": {
                                "set-name": "ip_stan_test",
                                "type": "ACL_IPV4"
                            }
                        }
                    ]
                }
            },
            {
                "id": "ethernet 1/1/6",
                "config": {
                    "id": "ethernet 1/1/6"
                },
                "egress-acl-sets": {
                    "egress-acl-set": [
                        {
                            "set-name": "ip_stan_test",
                            "type": "ACL_IPV4",
                            "config": {
                                "set-name": "ip_stan_test",
                                "type": "ACL_IPV4"
                            }
                        }
                    ]
                }
            }
        ]
    }
}

raw

Apply/update mac acl on ingress interface using PATCH  |  PATCH   https://10.176.128.99/restconf/data/acl/interfaces

Body
{
    "interfaces": {
        "interface": [
            {
                "id": "ethernet 1/1/10",
                "config": {
                    "id": "ethernet 1/1/10"
                },
                "ingress-acl-sets": {
                    "ingress-acl-set": [
                        {
                            "set-name": "bj5",
                            "type": "ACL_L2",
                            "config": {
                                "set-name": "bj5",
                                "type": "ACL_L2"
                            }
                        }
                    ]
                }
            }
        ]
    }
}

Delete specific ipv4 extended acl  |  DELETE   https://10.176.128.99/restconf/data/acl/acl-sets/acl-set/ext_acl1/ACL_IPV4

Description

To delete a specific ipv4 extended acl configured in the system


Delete L2 ACL configured in the system  |  DELETE   https://10.176.128.99/restconf/data/acl/acl-sets/acl-set/bj5/ACL_L2

Description

To delete a specific L2 acl(mac acl) configured in the system


Delete L2 acl binding on ingress interface  |  DELETE   https://10.176.128.99/restconf/data/acl/interfaces/interface/ethernet 1%2F1%2F10/ingress-acl-sets/ingress-acl-set/bj5/ACL_L2

Description

To delete L2 acl binding on ingress interface


Delete a specific ipv4 standard acl  |  DELETE   https://10.176.128.99/restconf/data/acl/acl-sets/acl-set/ip_stan_test/ACL_IPV4

Description

To delete a specific ipv4 standard acl configured in the system


Delete ipv4 acl binding on ingress interface  |  DELETE   https://10.176.128.99/restconf/data/acl/interfaces/interface/ethernet 1%2F1%2F1/ingress-acl-sets/ingress-acl-set/ext_acl1/ACL_IPV4


Delete ipv4 acl binding on egress interface  |  DELETE   https://10.176.128.99/restconf/data/acl/interfaces/interface/ethernet 1%2F1%2F2/egress-acl-sets/egress-acl-set/ext_acl1/ACL_IPV4

Description

To delete ipv4 acl binding on egress interface


Delete ipv6 acl binding on egress interface  |  DELETE   https://10.176.128.99/restconf/data/acl/interfaces/interface/ethernet 1%2F1%2F4/egress-acl-sets/egress-acl-set/acl_ipv61/ACL_IPV6

Description

To delete ipv6 acl binding on egress interface


Delete ipv6 acl binding on ingress interface  |  DELETE   https://10.176.128.99/restconf/data/acl/interfaces/interface/ethernet 1%2F1%2F3/ingress-acl-sets/ingress-acl-set/acl_ipv61/ACL_IPV6

Description

To delete ipv6 acl binding on ingress interface


Delete ipv6 acl configured in the system  |  DELETE   https://10.176.128.99/restconf/data/acl/acl-sets/acl-set/acl_ipv61/ACL_IPV6

Description

To delete a specific ipv6 acl configured in the system


Get a specific L2 ACL configured in the system  |  GET   https://10.176.128.99/restconf/data/acl/acl-sets/acl-set/bj5/ACL_L2

Description

To get/read specific L2 ACL(mac acl) configured in the system


Get all acl binding interfaces  |  GET   https://10.176.128.99/restconf/data/acl/interfaces

Description

To get/read all acl binding interfaces


Get all acls configured in the system  |  GET   https://10.176.128.99/restconf/data/acl/acl-sets

Description

To read/get acl configured in the system


Get ipv4 standard acl configured in the system  |  GET   https://10.176.128.99/restconf/data/acl/acl-sets/acl-set/ip_stan_test/ACL_IPV4

Description

To get/read specific ipv4 standard acl configured in the system


Get specific acl binded interface  |  GET   https://10.176.128.99/restconf/data/acl/interfaces/interface/ethernet 1%2F1%2F5

Description

To get/read specific acl binded interface


Get specific ipv6 acl configured in the system  |  GET   https://10.176.128.99/restconf/data/acl/acl-sets/acl-set/acl_ipv61/ACL_IPV6

Description

To get/read specific ipv6 acl configured in the system


raw

To apply/update ipv6 acl on ingress and egress interface using PATCH method  |  PATCH   https://10.176.128.99/restconf/data/acl/interfaces

Description

To apply/update ipv6 acl on ingress and egress interface using PATCH method

Body
{
    "interfaces": {
        "interface": [
            {
                "id": "ethernet 1/1/3",
                "config": {
                    "id": "ethernet 1/1/3"
                },
                "ingress-acl-sets": {
                    "ingress-acl-set": [
                        {
                            "set-name": "acl_ipv61",
                            "type": "ACL_IPV6",
                            "config": {
                                "set-name": "acl_ipv61",
                                "type": "ACL_IPV6"
                            }
                        }
                    ]
                }
            },
            {
                "id": "ethernet 1/1/4",
                "config": {
                    "id": "ethernet 1/1/4"
                },
                "egress-acl-sets": {
                    "egress-acl-set": [
                        {
                            "set-name": "acl_ipv61",
                            "type": "ACL_IPV6",
                            "config": {
                                "set-name": "acl_ipv61",
                                "type": "ACL_IPV6"
                            }
                        }
                    ]
                }
            }
        ]
    }
}

raw

apply ipv6 acl on ingress/egress interfaces using POST method  |  POST   https://10.176.128.99/restconf/data/acl

Description

To apply ipv6 acl on ingress/egress interfaces using POST method

Body
{
    "interfaces": {
        "interface": [
            {
                "id": "ethernet 1/1/3",
                "config": {
                    "id": "ethernet 1/1/3"
                },
                "ingress-acl-sets": {
                    "ingress-acl-set": [
                        {
                            "set-name": "acl_ipv61",
                            "type": "ACL_IPV6",
                            "config": {
                                "set-name": "acl_ipv61",
                                "type": "ACL_IPV6"
                            }
                        }
                    ]
                }
            },
            {
                "id": "ethernet 1/1/4",
                "config": {
                    "id": "ethernet 1/1/4"
                },
                "egress-acl-sets": {
                    "egress-acl-set": [
                        {
                            "set-name": "acl_ipv61",
                            "type": "ACL_IPV6",
                            "config": {
                                "set-name": "acl_ipv61",
                                "type": "ACL_IPV6"
                            }
                        }
                    ]
                }
            }
        ]
    }
}

raw

create ipv4 extended acl using POST method  |  POST   https://10.176.128.99/restconf/data/acl/acl-sets

Description

To create ipv4 extended acl with acl entries using POST method

Body
{
    "acl-set": [
        {
            "name": "ext_acl1",
            "type": "ACL_IPV4",
            "config": {
                "name": "ext_acl1",
                "type": "ACL_IPV4"
            },
            "acl-entries": {
                "acl-entry": [
                    {
                        "sequence-id": 10,
                        "config": {
                            "sequence-id": 10
                        },
                        "ipv4": {
                            "config": {
                                "source-address": "0.0.0.0",
                                "destination-address": "0.0.0.0",
                                "dscp": 0,
                                "protocol": 6
                            }
                        },
                        "transport": {
                            "config": {
                                "source-port": "0",
                                "destination-port": "0"
                            }
                        },
                        "actions": {
                            "config": {
                                "forwarding-action": "openconfig-acl:ACCEPT"
                            }
                        }
                    }
                ]
            }
        }
    ]
}

raw

create ipv4 std acl using POST  |  POST   https://10.176.128.99/restconf/data/acl/acl-sets

Description

To cretae ipv4 std acl using POST method

Body
{
    "acl-set": [
        {
            "name": "ip_stan_test",
            "type": "ACL_IPV4",
            "config": {
                "name": "ip_stan_test",
                "type": "ACL_IPV4"
            },
            "acl-entries": {
                "acl-entry": [
                    {
                        "sequence-id": 10,
                        "config": {
                            "sequence-id": 10
                        },
                        "ipv4": {
                            "config": {
                                "source-address": "10.157.29.12",
                                "destination-address": "0.0.0.0",
                                "dscp": 0,
                                "protocol": 0
                            }
                        },
                        "actions": {
                            "config": {
                                "forwarding-action": "openconfig-acl:DROP"
                            }
                        }
                    },
                    {
                        "sequence-id": 20,
                        "config": {
                            "sequence-id": 20
                        },
                        "ipv4": {
                            "config": {
                                "source-address": "0.0.0.0",
                                "destination-address": "0.0.0.0",
                                "dscp": 0,
                                "protocol": 0
                            }
                        },
                        "transport": {
                            "config": {
                                "source-port": "0",
                                "destination-port": "0"
                            }
                        },
                        "actions": {
                            "config": {
                                "forwarding-action": "openconfig-acl:ACCEPT"
                            }
                        }
                    }
                ]
            }
        }
    ]
}

raw

create ipv6 acl using POST method  |  POST   https://10.176.128.99/restconf/data/acl/acl-sets

Description

To cretae ipv6 acl withacl entries using POST method

Body
{
    "acl-set": [
        {
            "name": "acl_ipv61",
            "type": "ACL_IPV6",
            "config": {
                "name": "acl_ipv61",
                "type": "ACL_IPV6"
            },
            "acl-entries": {
                "acl-entry": [
                    {
                        "sequence-id": 10,
                        "config": {
                            "sequence-id": 10
                        },
                        "ipv6": {
                            "config": {
                                "source-address": "1000::10/120",
                                "destination-address": "2000::10/100",
                                "dscp": 0,
                                "protocol": "IP_TCP"
                            }
                        },
                        "actions": {
                            "config": {
                                "forwarding-action": "ACCEPT"
                            }
                        }
                    }
                ]
            }
        }
    ]
}

raw

create mac acl using POST  |  POST   https://10.176.128.99/restconf/data/acl/acl-sets

Description

To create mac acl using POST method

Body
{
    "acl-set": [
        {
            "name": "bj5",
            "type": "ACL_L2",
            "config": {
                "name": "bj5",
                "type": "ACL_L2"
            },
            "acl-entries": {
                "acl-entry": [
                    {
                        "sequence-id": 100,
                        "config": {
                            "sequence-id": 100
                        },
                        "l2": {
                            "config": {
                                "source-mac": "1111.2222.3333",
                                "source-mac-mask": "1111.2222.3333",
                                "destination-mac": "1111.2222.3333",
                                "destination-mac-mask": "1111.2222.3333",
                                "ethertype": 2048
                            }
                        },
                        "actions": {
                            "config": {
                                "forwarding-action": "ACCEPT"
                            }
                        }
                    }
                ]
            }
        }
    ]
}

raw

create/update ipv4 ext acl using PATCH  |  PATCH   https://10.176.128.99/restconf/data/acl/acl-sets

Description

To create/update ipv4 extended acl using PATCH method

Body
{
    "acl-sets": {
        "acl-set": [
            {
                "name": "ext3",
                "type": "ACL_IPV4",
                "config": {
                    "name": "ext3",
                    "type": "ACL_IPV4"
                },
                "acl-entries": {
                    "acl-entry": [
                        {
                            "sequence-id": 10,
                            "config": {
                                "sequence-id": 10
                            },
                            "ipv4": {
                                "config": {
                                    "source-address": "0.0.0.0",
                                    "destination-address": "0.0.0.0",
                                    "dscp": 0,
                                    "protocol": 6
                                }
                            },
                            "transport": {
                                "config": {
                                    "source-port": "0",
                                    "destination-port": "0"
                                }
                            },
                            "actions": {
                                "config": {
                                    "forwarding-action": "openconfig-acl:ACCEPT"
                                }
                            }
                        }
                    ]
                }
            }
        ]
    }
}

raw

create/update ipv4 std acl using PATCH  |  PATCH   https://10.176.128.99/restconf/data/acl/acl-sets

Description

To create/update ipv4 std acl using PATCH method

Body
{
    "acl-sets": {
        "acl-set": [
            {
                "name": "ip_stan_test1",
                "type": "ACL_IPV4",
                "config": {
                    "name": "ip_stan_test1",
                    "type": "ACL_IPV4"
                },
                "acl-entries": {
                    "acl-entry": [
                        {
                            "sequence-id": 10,
                            "config": {
                                "sequence-id": 10
                            },
                            "ipv4": {
                                "config": {
                                    "source-address": "10.157.29.12",
                                    "destination-address": "0.0.0.0",
                                    "dscp": 0,
                                    "protocol": 0
                                }
                            },
                            "actions": {
                                "config": {
                                    "forwarding-action": "openconfig-acl:DROP"
                                }
                            }
                        },
                        {
                            "sequence-id": 20,
                            "config": {
                                "sequence-id": 20
                            },
                            "ipv4": {
                                "config": {
                                    "source-address": "0.0.0.0",
                                    "destination-address": "0.0.0.0",
                                    "dscp": 0,
                                    "protocol": 0
                                }
                            },
                            "transport": {
                                "config": {
                                    "source-port": "0",
                                    "destination-port": "0"
                                }
                            },
                            "actions": {
                                "config": {
                                    "forwarding-action": "openconfig-acl:ACCEPT"
                                }
                            }
                        }
                    ]
                }
            }
        ]
    }
}

raw

create/update ipv6 acl using PATCH method  |  PATCH   https://10.176.128.99/restconf/data/acl/acl-sets

Description

To create/update ipv6 acl using PATCH method

Body
{
    "acl-sets": {
        "acl-set": [
            {
                "name": "acl_ipv61",
                "type": "ACL_IPV6",
                "config": {
                    "name": "acl_ipv61",
                    "type": "ACL_IPV6"
                },
                "acl-entries": {
                    "acl-entry": [
                        {
                            "sequence-id": 10,
                            "config": {
                                "sequence-id": 10
                            },
                            "ipv6": {
                                "config": {
                                    "source-address": "1000::10/120",
                                    "destination-address": "2000::10/100",
                                    "dscp": 0,
                                    "protocol": "IP_TCP"
                                }
                            },
                            "actions": {
                                "config": {
                                    "forwarding-action": "ACCEPT"
                                }
                            }
                        }
                    ]
                }
            }
        ]
    }
}

raw

create/update mac acl using PATCH method  |  PATCH   https://10.176.128.99/restconf/data/acl/acl-sets

Description

To create/update mac acl using PATCH method

Body
{
    "acl-sets": {
        "acl-set": [
            {
                "name": "bj5",
                "type": "ACL_L2",
                "config": {
                    "name": "bj5",
                    "type": "ACL_L2"
                },
                "acl-entries": {
                    "acl-entry": [
                        {
                            "sequence-id": 100,
                            "config": {
                                "sequence-id": 100
                            },
                            "l2": {
                                "config": {
                                    "source-mac": "1111.2222.3333",
                                    "source-mac-mask": "1111.2222.3333",
                                    "destination-mac": "1111.2222.3333",
                                    "destination-mac-mask": "1111.2222.3333",
                                    "ethertype": 2048
                                }
                            },
                            "actions": {
                                "config": {
                                    "forwarding-action": "ACCEPT"
                                }
                            }
                        }
                    ]
                }
            }
        ]
    }
}

get ipv4 extended acl configured in the system  |  GET   https://10.176.128.99/restconf/data/acl/acl-sets/acl-set/ext_acl1/ACL_IPV4

Description

To get/read specific ipv4 extended acl configured in the system


DNS 7

raw

create DNS server using POST  |  POST   https://10.176.128.99/restconf/data/system/dns/servers

Description

create DNS server thro POST method

Body
{
    "server": [
        {
            "address": "20.1.1.1",
            "config": {
                "address": "20.1.1.1"
            }
        }
    ]
}

delete all dns server  |  DELETE   https://10.176.128.99/restconf/data/system/dns/servers

Description

To delete all dns server configured in the system


delete specific dns server  |  DELETE   https://10.176.128.99/restconf/data/system/dns/servers/server/60.1.1.1

Description

To delete specific dns server


get all DNS server configured in the switch  |  GET   https://10.176.128.99/restconf/data/system/dns

Description

read/get all DNS servers configured in the system


get specific dns server  |  GET   https://10.176.128.99/restconf/data/system/dns/servers/server/30.1.1.1

Description

To get specific dns server configured in the system


raw

replace DNS server using PUT  |  PUT   https://10.176.128.99/restconf/data/system/dns/servers

Description

replace existing DNS server with new server using PUT method

Body
{
    "servers": {
        "server": [
            {
                "address": "30.1.1.1",
                "config": {
                    "address": "30.1.1.1"
                }
            }
        ]
    }
}

raw

update/append DNS server using using PATCH  |  PATCH   https://10.176.128.99/restconf/data/system/dns/servers

Description

updating/appending DNS server using PATCH

Body
{
    "servers": {
        "server": [
            {
                "address": "40.1.1.1",
                "config": {
                    "address": "40.1.1.1"
                }
            }
        ]
    }
}

Interface 10

Delete ip address on interface  |  DELETE   https://10.176.128.99/restconf/data/interfaces/interface/ethernet 1%2F1%2F2/subinterfaces/subinterface/0/ipv4/addresses/address/36.1.1.1

Description

To delete ip address assigned on interface using delete method


raw

assign ip address on interface using POST method  |  POST   https://10.176.128.99/restconf/data/interfaces/interface/ethernet 1%2F1%2F1/subinterfaces

Description

To assign ip address on interface using POST method

Body
{
    "subinterface": [
        {
            "index": 0,
            "config": {
                "index": 0
            },
            "openconfig-if-ip:ipv4": {
                "addresses": {
                    "address": [
                        {
                            "ip": "36.1.1.1",
                            "config": {
                                "ip": "36.1.1.1",
                                "prefix-length": 25
                            }
                        }
                    ]
                }
            }
        }
    ]
}

raw

disable interface using PATCH method  |  PATCH   https://10.176.128.99/restconf/data/interfaces

Description

To disable interface using PATCH method

Body
{
    "interfaces": {
        "interface": [
            {
                "name": "ethernet 1/1/1",
                "config": {
                    "name": "ethernet 1/1/1",
                    "type": "iana-if-type:ethernetCsmacd",
                    "description": "",
                    "enabled": false
                }
            }
        ]
    }
}

raw

enable interface using PATCH  |  PATCH   https://10.176.128.99/restconf/data/interfaces

Description

To enable interface using PATCH method

Body
{
    "interfaces": {
        "interface": [
            {
                "name": "ethernet 1/1/1",
                "config": {
                    "name": "ethernet 1/1/1",
                    "type": "iana-if-type:ethernetCsmacd",
                    "description": "",
                    "enabled": true
                }
            }
        ]
    }
}

get all interfaces  |  GET   https://10.176.128.99/restconf/data/interfaces

Description

To read/get all interfaces in the system


get ip address asiigned on specific interface  |  GET   https://10.176.128.99/restconf/data/interfaces/interface/ethernet 1%2F1%2F6/subinterfaces/subinterface/1/ipv4/addresses/address

Description

To get/read ip address on specific interface


get state of a speciifc interface  |  GET   https://10.176.128.99/restconf/data/interfaces/interface=ethernet%201%2F1%2F2/state

Description

To get/read state of a specific interface


raw

update port description using PATCH  |  PATCH   https://10.176.128.99/restconf/data/interfaces

Description

To update port description using PATCH method

Body
{
    "interfaces": {
        "interface": [
            {
                "name": "ethernet 1/1/1",
                "config": {
                    "name": "ethernet 1/1/1",
                    "type": "iana-if-type:ethernetCsmacd",
                    "description": "port 1",
                    "enabled": true
                }
            }
        ]
    }
}

raw

update port speed using PATCH  |  PATCH   https://10.176.128.99/restconf/data/interfaces/interface/ethernet 1%2F1%2F3/ethernet/config

Description

To update the port speed using PATCH method

Body
{
    "config": {
        "auto-negotiate": false,
        "duplex-mode": "FULL",
        "port-speed": "openconfig-if-ethernet:SPEED_10GB",
        "icx-openconfig-if-ethernet-aug:ethernet-clock": "slave"
    }
}

raw

update/assign ip address on interface using PATCH method  |  PATCH   https://10.176.128.99/restconf/data/interfaces/interface/ethernet 1%2F1%2F6/subinterfaces

Description

To update/assign ip address on interface using PATCH method

Body
{
    "subinterfaces": {
        "subinterface": [
            {
                "index": 1,
                "config": {
                    "index": 1
                },
                "openconfig-if-ip:ipv4": {
                    "addresses": {
                        "address": [
                            {
                                "ip": "37.1.1.1",
                                "config": {
                                    "ip": "37.1.1.1",
                                    "prefix-length": 25
                                }
                            }
                        ]
                    }
                }
            }
        ]
    }
}

LAG 11

Delete specific lag  |  DELETE   https://10.176.128.99/restconf/data/interfaces/interface/lag 5

Description

To delete a specific lag


Deleting a port from a lag  |  DELETE   https://10.176.128.99/restconf/data/interfaces/interface/ethernet 1%2F1%2F2/ethernet/config/aggregate-id

Description

To delete a port from a LAG


raw

To add/update the ports to LAG using PATCH  |  PATCH   https://10.176.128.99/restconf/data/interfaces/interface/ethernet 1%2F1%2F13/ethernet/config

Description

To add/update the ports to LAG using PATCH method

Body
{
    "config": {
        "openconfig-if-aggregate:aggregate-id": "lag 7"
    }
}

raw

add ports to LAG using POST method  |  POST   https://10.176.128.99/restconf/data/interfaces/interface/ethernet 1%2F1%2F12/ethernet/config

Description

To add ports to LAG using POST method

Body
{
    "openconfig-if-aggregate:aggregate-id": "lag 7"
}

raw

create dynamic LAG using POST method  |  POST   https://10.176.128.99/restconf/data/interfaces

Description

Create dynamic LAG using POST method

Body
{
    "interface": [
        {
            "name": "lag 4",
            "config": {
                "name": "lag 4",
                "type": "iana-if-type:ieee8023adLag",
                "enabled": true
            },
            "openconfig-if-aggregate:aggregation": {
                "config": {
                    "lag-type": "LACP"
                }
            }
        }
    ]
}

raw

create static LAG using POST method  |  POST   https://10.176.128.99/restconf/data/interfaces

Description

To create static LAG using POST method

Body
{
    "interface": [
        {
            "name": "lag 4",
            "config": {
                "name": "lag 4",
                "type": "iana-if-type:ieee8023adLag",
                "enabled": true
            },
            "openconfig-if-aggregate:aggregation": {
                "config": {
                    "lag-type": "STATIC"
                }
            }
        }
    ]
}

raw

create/update dynamic LAG using PATCH  |  PATCH   https://10.176.128.99/restconf/data/interfaces

Description

create/update dynamic LAG using PATCH

Body
{
    "interfaces": {
        "interface": [
            {
                "name": "lag 7",
                "config": {
                    "name": "lag 7",
                    "type": "iana-if-type:ieee8023adLag",
                    "enabled": true
                },
                "openconfig-if-aggregate:aggregation": {
                    "config": {
                        "lag-type": "LACP"
                    }
                }
            }
        ]
    }
}

raw

create/update static LAG using PATCH method  |  PATCH   https://10.176.128.99/restconf/data/interfaces

Description

create/update static LAG using PATCH method

Body
{
    "interfaces": {
        "interface": [
            {
                "name": "lag 6",
                "config": {
                    "name": "lag 6",
                    "type": "iana-if-type:ieee8023adLag",
                    "enabled": true
                },
                "openconfig-if-aggregate:aggregation": {
                    "config": {
                        "lag-type": "STATIC"
                    }
                }
            }
        ]
    }
}

get a LAG configured on specific interface  |  GET   https://10.176.128.99/restconf/data/interfaces/interface/ethernet 1%2F1%2F10/ethernet/config/aggregate-id

Description

To get/read LAG configured on specific interface


get a specific LAG configured in the system  |  GET   https://10.176.128.99/restconf/data/interfaces/interface=lag%207

Description

To get/read specific LAG configured in the system


get all LAGS configured in the system  |  GET   https://10.176.128.99/restconf/data/interfaces

Description

To get/read all LAG interfaces configured in the system


LLDP 10

raw

diable lldp on interface using PATCH  |  PATCH   https://10.176.128.99/restconf/data/lldp/interfaces

Description

To disable lldp on interface using PATCH method

Body
{
    "interfaces": {
        "interface": [
            {
                "name": "ethernet 1/1/1",
                "config": {
                    "name": "ethernet 1/1/1",
                    "enabled": false
                }
            }
        ]
    }
}

raw

disable global level lldp using PUT  |  PUT   https://10.176.128.99/restconf/data/lldp/config

Description

To disable global level lldp using PUT method

Body
{
    "config": {
        "enabled": false
    }
}

raw

disable global lldp using PATCH  |  PATCH   https://10.176.128.99/restconf/data/lldp/config

Description

To disable global level lldp using PATCH method

Body
{
    "config": {
        "enabled": false
    }
}

raw

enable global lldp using PATCH  |  PATCH   https://10.176.128.99/restconf/data/lldp/config

Description

To enable global level lldp using PATCH method

Body
{
    "config": {
        "enabled": true
    }
}

raw

enable global lldp using PUT  |  PUT   https://10.176.128.99/restconf/data/lldp/config

Description

To enable global level lldp using PUT method

Body
{
    "config": {
        "enabled": true
    }
}

raw

enable lldp on interface using PATCH  |  PATCH   https://10.176.128.99/restconf/data/lldp/interfaces

Description

To enable lldp on specific interface using PATCH method

Body
{
    "interfaces": {
        "interface": [
            {
                "name": "ethernet 1/1/1",
                "config": {
                    "name": "ethernet 1/1/1",
                    "enabled": true
                }
            }
        ]
    }
}

get global lldp status  |  GET   https://10.176.128.99/restconf/data/lldp/config

Description

To get global lldp status


get lldp status of all interfaces  |  GET   https://10.176.128.99/restconf/data/lldp/interfaces

Description

To get lldp status of all interfaces


get lldp status of all interfaces  |  GET   https://10.176.128.99/restconf/data/lldp/interfaces

Description

To get/read lldp status of all interfaces


get lldp status of specific interface  |  GET   https://10.176.128.99/restconf/data/lldp/interfaces/interface=ethernet%201%2F1%2F1

Description

To read/get lldp status of specific interface


OSPF 10

raw

create ospf area using POST method  |  POST   https://10.176.128.99/restconf/data/network-instances/network-instance/default-vrf/protocols

Body
{
    "protocol": [
        {
            "identifier": "OSPF",
            "name": "icx-ospf",
            "config": {
                "identifier": "OSPF",
                "name": "icx-ospf"
            },
            "ospfv2": {
                "areas": {
                    "area": [
                        {
                            "identifier": "0.0.0.0",
                            "config": {
                                "identifier": "0.0.0.0"
                            }
                        }
                    ]
                }
            }
        }
    ]
}

raw

create ospf binding interface using PATCH operation  |  PATCH   https://10.176.128.99/restconf/data/network-instances/network-instance/default-vrf/protocols/protocol/OSPF/icx-ospf/ospfv2/areas/area/0.0.0.11/interfaces

Description

bind interfce(assign ip address) to an ospf area using patch operation

Body
{
    "interfaces": {
        "interface": [
            {
                "id": "ethernet 1/1/3",
                "config": {
                    "id": "ethernet 1/1/3"
                }
            }
        ]
    }
}

raw

create ospf binding interface using POST operation  |  POST   https://10.176.128.99/restconf/data/network-instances/network-instance/default-vrf/protocols/protocol/OSPF/icx-ospf/ospfv2/areas/area/0.0.0.11/interfaces

Description

bind interface(assign ip address) to an ospf area using POST operation

Body
{
    "interface": [
        {
            "id": "ethernet 1/1/2",
            "config": {
                "id": "ethernet 1/1/2"
            }
        }
    ]
}

raw

create/update ospf area using PATCH method  |  PATCH   https://10.176.128.99/restconf/data/network-instances/network-instance/default-vrf/protocols

Description

To create/update ospf area using PATCH method

Body
{
    "protocols": {
        "protocol": [
            {
                "identifier": "OSPF",
                "name": "icx-ospf",
                "config": {
                    "identifier": "OSPF",
                    "name": "icx-ospf"
                },
                "ospfv2": {
                    "areas": {
                        "area": [
                            {
                                "identifier": "20.1.1.1",
                                "config": {
                                    "identifier": "20.1.1.1"
                                }
                            }
                        ]
                    }
                }
            }
        ]
    }
}

delete all ospf areas  |  DELETE   https://10.176.128.99/restconf/data/network-instances/network-instance/default-vrf/protocols/protocol/OSPF/icx-ospf/ospfv2/areas

Description

To delete all ospf areas configured in the system


delete specific ospf area  |  DELETE   https://10.176.128.99/restconf/data/network-instances/network-instance/default-vrf/protocols/protocol/OSPF/icx-ospf/ospfv2/areas/area/20.1.1.1

Description

delete specific ospf area configured in the system


get all ospf areas configured in the system  |  GET   https://10.176.128.99/restconf/data/network-instances/network-instance/default-vrf/protocols/protocol/OSPF/icx-ospf/ospfv2/areas

Description

To get/read all ospf areas configured in the system


get specific ospf area  |  GET   https://10.176.128.99/restconf/data/network-instances/network-instance/default-vrf/protocols/protocol/OSPF/icx-ospf/ospfv2/areas/area/20.1.1.1

Description

To get/read specific ospf area configured in the system


remove all interface binding from a ospf area  |  DELETE   https://10.176.128.99/restconf/data/network-instances/network-instance/default-vrf/protocols/protocol/OSPF/icx-ospf/ospfv2/areas/area/0.0.0.11/interfaces

Description

remove all interface binding from the opsf area


remove interface binding from the ospf area using DELETE operation  |  DELETE   https://10.176.128.99/restconf/data/network-instances/network-instance/default-vrf/protocols/protocol/OSPF/icx-ospf/ospfv2/areas/area/0.0.0.11/interfaces/interface/ethernet 1%2F1%2F1

Description

remove interface binding from the ospf interface


PoE 10

raw

disable PoE on specific interface using PATCH  |  PATCH   https://10.176.128.137/restconf/data/interfaces/interface=ethernet%201%2F1%2F2/ethernet/poe

Description

To disable PoE on specific interface using PATCH method

Body
{
    "poe": {
        "config": {
            "enabled": false
        }
    }
}

raw

disable PoE on specific interface using PUT  |  PUT   https://10.176.128.137/restconf/data/interfaces/interface=ethernet%201%2F1%2F2/ethernet/poe

Description

To disable PoE on specific interface

Body
{
    "poe": {
        "config": {
            "enabled": false
        }
    }
}

raw

enable PoE on specific interface using PATCH  |  PATCH   https://10.176.128.137/restconf/data/interfaces/interface=ethernet%201%2F1%2F2/ethernet/poe

Description

enable PoE on specific interface using PoE method

Body
{
    "poe": {
        "config": {
            "enabled": true
        }
    }
}

raw

enable PoE on specific interface using PoE  |  PUT   https://10.176.128.137/restconf/data/interfaces/interface=ethernet%201%2F1%2F2/ethernet/poe

Description

To enable PoE on specific interface using PUT method

Body
{
    "poe": {
        "config": {
            "enabled": true
        }
    }
}

get PoE enabled status on specific interface  |  GET   https://10.176.128.137/restconf/data/interfaces/interface=ethernet%201%2F1%2F1/ethernet/poe/state/enabled

Description

To read/get PoE enabled status on specific interface


get PoE on all interfaces  |  GET   https://10.176.128.137/restconf/data/interfaces

Description

To read/get PoE status/values on all interfaces


get configured PoE status on specific interface  |  GET   https://10.176.128.137/restconf/data/interfaces/interface=ethernet%201%2F1%2F1/ethernet/poe

Description

To read/get configured PoE status on specific interface


get poe state values of specific interface  |  GET   https://10.176.128.137/restconf/data/interfaces/interface=ethernet%201%2F1%2F1/ethernet/poe/state

Description

To get/read poe state values on specific values


get power-class on specific PoE interface  |  GET   https://10.176.128.137/restconf/data/interfaces/interface=ethernet%201%2F1%2F1/ethernet/poe/state/power-class

Description

To read/get power-class on specific PoE interface


get power-used on specifc PoE interface  |  GET   https://10.176.128.137/restconf/data/interfaces/interface=ethernet%201%2F1%2F1/ethernet/poe/state/power-used

Description

To read/get power-used on specific PoE interface


STP 7

Delete rstp on specific vlan  |  DELETE   https://10.176.128.99/restconf/data/stp/rapid-pvst/vlan/20

Description

To delete rstp on specific vlan


raw

disable bpdu-guard on interface using PATCH  |  PATCH   https://10.176.128.99/restconf/data/stp/interfaces

Description

To disable bpdu-guard on interface using PATCH method

Body
{
    "interfaces": {
        "interface": [
            {
                "name": "ethernet 1/1/4",
                "config": {
                    "name": "ethernet 1/1/4",
                    "bpdu-guard": false
                }
            }
        ]
    }
}

raw

enable rstp on vlan using POST  |  POST   https://10.176.128.99/restconf/data/stp/rapid-pvst

Description

To enable STP on vlan using POST method

Body
{
    "vlan": [
        {
            "vlan-id": 20,
            "config": {
                "vlan-id": 20
            }
        }
    ]
}

raw

enable bpdu-guard on interface using PATCH  |  PATCH   https://10.176.128.99/restconf/data/stp/interfaces

Description

To enable bpdu-guard on interface using PATCH

Headers
KeyValueDescription
Content-Typeapplication/json
Body
{
    "interfaces": {
        "interface": [
            {
                "name": "ethernet 1/1/4",
                "config": {
                    "name": "ethernet 1/1/4",
                    "bpdu-guard": true
                }
            }
        ]
    }
}

raw

enable rstp on vlan using PATCH  |  PATCH   https://10.176.128.99/restconf/data/stp/rapid-pvst

Description

To enable rstp on vlan using PATCH

Body
{
    "rapid-pvst": {
        "vlan": [
            {
                "vlan-id": 30,
                "config": {
                    "vlan-id": 30
                }
            }
        ]
    }
}

raw

get default spanning tree status  |  GET   https://10.176.128.99/restconf/data/stp

Description

To get/read default stp status

Body
{
    "openconfig-interfaces:interfaces": {
        "interface": [
            {
                "name": "ethernet 1/1/1",
                "config": {
                    "name": "ethernet 1/1/1",
                    "type": "iana-if-type:ethernetCsmacd",
                    "description": "",
                    "enabled": false
                }
            }
        ]
    }
}

get rstp on specific vlan  |  GET   https://10.176.128.99/restconf/data/stp/rapid-pvst/vlan/20

Description

To get/read rstp on specific vlan


Static Route 5

raw

create static route using POST  |  POST   https://10.176.128.99/restconf/data/network-instances/network-instance/default-vrf/protocols

Description

To create static route using POST method

Body
{
    "protocol": {
        "identifier": "openconfig-policy-types:STATIC",
        "name": "icx-static",
        "config": {
            "identifier": "openconfig-policy-types:STATIC",
            "name": "icx-static"
        },
        "static-routes": {
            "static": [
                {
                    "prefix": "44.1.1.1/16",
                    "config": {
                        "prefix": "44.1.1.1/16"
                    },
                    "next-hops": {
                        "next-hop": [
                            {
                                "index": "10.176.128.1",
                                "config": {
                                    "index": "10.176.128.1",
                                    "next-hop": "10.176.128.1"
                                }
                            }
                        ]
                    }
                }
            ]
        }
    }
}

raw

create/update static route using PATCH method  |  PATCH   https://10.176.128.99/restconf/data/network-instances/network-instance/default-vrf/protocols

Description

To create/update static route using PATCH method

Body
{
    "protocols": {
        "protocol": {
            "identifier": "openconfig-policy-types:STATIC",
            "name": "icx-static",
            "config": {
                "identifier": "openconfig-policy-types:STATIC",
                "name": "icx-static"
            },
            "static-routes": {
                "static": [
                    {
                        "prefix": "55.1.1.1/16",
                        "config": {
                            "prefix": "55.1.1.1/16"
                        },
                        "next-hops": {
                            "next-hop": [
                                {
                                    "index": "10.176.128.1",
                                    "config": {
                                        "index": "10.176.128.1",
                                        "next-hop": "10.176.128.1"
                                    }
                                }
                            ]
                        }
                    }
                ]
            }
        }
    }
}

delete specific static route  |  DELETE   https://10.176.128.99/restconf/data/network-instances/network-instance/default-vrf/protocols/protocol/STATIC/icx-static/static-routes/static/44.1.0.0%2F16

Description

To delete a specific static route configured in the system using delete method


get all static routes configured in the system  |  GET   https://10.176.128.99/restconf/data/network-instances/network-instance/default-vrf/protocols/protocol/STATIC/icx-static

Description

To get all static routes configured in the system


get specific static route configured in the system  |  GET   https://10.176.128.99/restconf/data/network-instances/network-instance/default-vrf/protocols/protocol/STATIC/icx-static/static-routes/static/44.1.0.0%2F16

Description

To get/read specific static route configured in the system


VLAN 13

raw

Create/replace vlans using PUT operation  |  PUT   https://10.176.128.99/restconf/data/network-instances/network-instance/default-vrf/vlans

Description

create/replace vlans using PUT operation

Body
{
    "vlans": {
        "vlan": [
            {
                "vlan-id": 20,
                "config": {
                    "vlan-id": 20,
                    "name": "user-vlan-20"
                }
            },
            {
                "vlan-id": 1,
                "config": {
                    "vlan-id": 1,
                    "name": "DEFAULT-VLAN"
                }
            }
        ]
    }
}

Delete untag ports from access vlans using delete method  |  DELETE   https://10.176.128.99/restconf/data/interfaces/interface/ethernet 1%2F1%2F4/ethernet/switched-vlan/config/access-vlan

Description

To delete untag ports from access vlans using delete method on specific interface


Get vlans on specific interface  |  GET   https://10.176.128.99/restconf/data/interfaces/interface=ethernet%201%2F1%2F8/ethernet/switched-vlan

Description

To get/read vlans configured on specific vlans


To delete a specific vlan  |  DELETE   https://10.176.128.99/restconf/data/network-instances/network-instance/default-vrf/vlans/vlan/10

Description

To delete a specific vlan using DELETE method


To get specific vlan  |  GET   https://10.176.128.99/restconf/data/network-instances/network-instance/default-vrf/vlans/vlan/10

Description

To read/get specific vlan using GET method


raw

create vlan using POST  |  POST   https://10.176.128.99/restconf/data/network-instances/network-instance/default-vrf/vlans

Description

To create new vlan using POST method

Body
{
    "vlan": [
        {
            "vlan-id": 10,
            "config": {
                "vlan-id": 10,
                "name": "user-vlan-10"
            }
        }
    ]
}

delete tagging ports from vlan using PATCH  |  DELETE   https://10.176.128.99/restconf/data/interfaces/interface/ethernet 1%2F1%2F7/ethernet/switched-vlan/config/trunk-vlans/10

Description

To delete tagging ports from vlan using PATCH


raw

get all vlans configured on the system  |  GET   https://10.176.128.99/restconf/data/network-instances/network-instance/default-vrf/vlans

Description

To get/read all vlans configured in the system


raw

tagging ports in trunk vlans using PATCH method  |  PATCH   https://10.176.128.99/restconf/data/interfaces/interface/ethernet 1%2F1%2F8/ethernet/switched-vlan

Description

Tagging ports in trunk vlans using PATCH method

Body
{
    "openconfig-vlan:switched-vlan": {
        "config": {
            "trunk-vlans": [
                10,
                20,
                30
            ]
        }
    }
}

raw

tagging ports in trunk vlans using POST  |  POST   https://10.176.128.99/restconf/data/interfaces/interface/ethernet 1%2F1%2F1/ethernet/switched-vlan

Description

tag ports in trunk vlans using POST method

Body
{
    "config": {
        "trunk-vlans": [
            10,
            20,
            30
        ]
    }
}

raw

untagging ports in access vlans using PATCH  |  PATCH   https://10.176.128.99/restconf/data/interfaces/interface/ethernet 1%2F1%2F9/ethernet/switched-vlan

Description

Untag ports in access vlans using PATCH method

Body
{
    "openconfig-vlan:switched-vlan": {
        "config": {
            "access-vlan": 20
        }
    }
}

raw

untagging ports in access vlans using POST  |  POST   https://10.176.128.99/restconf/data/interfaces/interface/ethernet 1%2F1%2F2/ethernet/switched-vlan

Description

untag ports in access vlan using POST method

Body
{
    "config": {
        "access-vlan": 10
    }
}

raw

update/create vlan using PATCH  |  PATCH   https://10.176.128.99/restconf/data/network-instances/network-instance/default-vrf/vlans

Description

To update/create vlan using PATCH method

Body
{
    "vlans": {
        "vlan": [
            {
                "vlan-id": 20,
                "config": {
                    "vlan-id": 20,
                    "name": "user-vlan-20"
                }
            }
        ]
    }
}

Virtual interface 6

raw

Create virtual interface with ip address using POST method  |  POST   https://10.176.128.99/restconf/data/interfaces

Description

To create virtual interface with ip address using POST method

Body
{
    "interface": [
        {
            "name": "ve 40",
            "config": {
                "name": "ve 40",
                "type": "iana-if-type:l3ipvlan"
            },
            "openconfig-vlan:routed-vlan": {
                "config": {
                    "vlan": 40
                },
                "openconfig-if-ip:ipv4": {
                    "addresses": {
                        "address": [
                            {
                                "ip": "40.1.1.1",
                                "config": {
                                    "ip": "40.1.1.1",
                                    "prefix-length": 25
                                }
                            }
                        ]
                    }
                }
            }
        }
    ]
}

raw

Create/update virtual interface using PATCH method  |  PATCH   https://10.176.128.99/restconf/data/interfaces

Description

To cretae/update virtual interface using PATCH method

Body
{
    "interfaces": {
        "interface": [
            {
                "name": "ve 60",
                "config": {
                    "name": "ve 60",
                    "type": "iana-if-type:l3ipvlan"
                }
            }
        ]
    }
}

raw

Cretae/update virtual interface with ip address using PATCH method  |  PATCH   https://10.176.128.99/restconf/data/interfaces

Description

To create/update virtual interface with ip address using PATCH method

Body
{
    "interfaces": {
        "interface": [
            {
                "name": "ve 70",
                "config": {
                    "name": "ve 70",
                    "type": "iana-if-type:l3ipvlan"
                },
                "openconfig-vlan:routed-vlan": {
                    "config": {
                        "vlan": 70
                    },
                    "openconfig-if-ip:ipv4": {
                        "addresses": {
                            "address": [
                                {
                                    "ip": "70.1.1.1",
                                    "config": {
                                        "ip": "70.1.1.1",
                                        "prefix-length": 25
                                    }
                                }
                            ]
                        }
                    }
                }
            }
        ]
    }
}

raw

create virtual interface using POST method  |  POST   https://10.176.128.99/restconf/data/interfaces

Description

To create virtual interface using POST method

Body
{
    "interface": [
        {
            "name": "ve 50",
            "config": {
                "name": "ve 50",
                "type": "iana-if-type:l3ipvlan"
            }
        }
    ]
}

delete a virtual interface  |  DELETE   https://10.176.128.99/restconf/data/interfaces/interface/ve 40

Description

To delete specific virtual interface


get specific virtual interface  |  GET   https://10.176.128.99/restconf/data/interfaces/interface/ve 2

Description

To get/read specific virtual interface