Network Commands
- Last Updated: October 14, 2024
- 5 minute read
- LoadMaster
- Kemp 360 Central
- Documentation
The Network resource allows several operations to be performed in relation to the network(s) in Kemp 360 Central.
Retrieve Details of the Network(s)
You can use a GET method to retrieve details of the network(s).
/api/v1/network/?&api_key=APIKey&username=UsernameThe next example retrieves a full list of details for all networks that have been added to Kemp 360 Central. The output includes an id. This id number can be used to retrieve details of one specific network by entering the ID number after the resource name, for example - the following command displays details for the network with ID number 2:
/api/v1/network/2/?&api_key=de26b104526be42ec7e0454d363345a15be4c453&username=adminExample Command
curl -k --dump-header - -X GET "https://Kemp360CentralIPAddress/api/v1/network/2/?api_key=179d4f59c5ef97e7b6f7035eb296cdcefcc1e88f&username=admin"Expected Output
HTTP/1.1 200 OKDate: Wed, 15 Aug 2018 07:42:24 GMTServer: ApacheX-Frame-Options: SAMEORIGINCache-Control: no-cacheVary: AcceptTransfer-Encoding: chunkedContent-Type: application/json{"cidr": 24, "created_at": "2018-08-14T07:49:26", "id": 3, "info": {"broadcast": "10.35.29.255", "hosts": 254, "max": "10.35.29.254", "min": "10.35.29.1", "netmask": "255.255.255.0", "wildcard": "0.0.0.255"}, "iprange": "10.35.29.0", "loadmasters": [{"asl_instance": true, "aws_lb_name": null, "aws_region": null, "capabilities": {"backup": {"read": true, "write": true}, "device_config": {"read": true, "write": true}, "firmware": {"read": true, "write": true}, "logs": {"read": true, "write": true}, "reboot": {"read": true, "write": true}, "restore": {"read": true, "write": true}, "shutdown": {"read": true, "write": true}, "stats": {"read": true, "write": false}, "templates": {"read": true, "write": true}, "virtual_services": {"read": true, "write": true}}, "client_cert": true, "cluster_members": [], "cluster_node": null, "created_at": "2018-08-14T08:08:46", "critical_host_syslog": "", "datahash": "b'\\x8c\\x89?\\x8c\\x8f\\xb2\\x10\\xfb\\x84\\xa7\\xe58\\x8f9\\x96\\xf3\\xfb\\xe9S\\x17'", "device_type": 1, "emergency_host_syslog": "", "error_host_syslog": "", "ha_mode": 0, "ha_status": "", "ha_type": "", "id": 5, "info_host_syslog": "10.35.29.120", "ip_address": "10.35.29.3", "last_stats": null, "last_stats_time": "2018-08-14T08:08:46", "last_up": "2018-08-15T07:42:02", "lmusername": null, "management_interface": 0, "network": "/api/v1/network/3/", "nickname": null, "notice_host_syslog": "", "port": 443, "public_access_address": "", "resource_uri": "/api/v1/loadmaster/5/", "service_groups": ["/api/v1/servicegroup/33/", "/api/v1/servicegroup/34/"], "source": "admin", "status_uri": null, "system_status": "UP", "updated_at": "2018-08-14T09:42:07", "valid_parent_networks": [{"cidr": 24, "id": 3, "iprange": "10.35.29.0", "nickname": null, "resource_uri": "/api/v1/network/3/"}], "version": "7.2.40.0.15707.RELEASE", "warn_host_syslog": ""}, {"asl_instance": false, "aws_lb_name": null, "aws_region": null, "capabilities": {"backup": {"read": true, "write": false}, "device_config": {"read": true, "write": true}, "firmware": {"read": true, "write": false}, "logs": {"read": true, "write": false}, "reboot": {"read": true, "write": false}, "restore": {"read": true, "write": false}, "shutdown": {"read": true, "write": false}, "stats": {"read": true, "write": false}, "templates": {"read": true, "write": false}, "virtual_services": {"read": true, "write": false}}, "client_cert": true, "cluster_members": [], "cluster_node": null, "created_at": "2018-08-15T07:32:20", "critical_host_syslog": "", "datahash": "b'\\x19O\\xfb\\x86\\x88\\x90\\n\\xd9Nu^\\x8a\\x99\\xa5C\\x9e!pKK'", "device_type": 1, "emergency_host_syslog": "", "error_host_syslog": "", "ha_mode": 0, "ha_status": "", "ha_type": "", "id": 8, "info_host_syslog": "10.35.29.120", "ip_address": "10.35.29.138", "last_stats": null, "last_stats_time": "2018-08-15T07:32:17", "last_up": "2018-08-15T07:42:02", "lmusername": null, "management_interface": 0, "network": "/api/v1/network/3/", "nickname": null, "notice_host_syslog": "", "port": 443, "public_access_address": "", "resource_uri": "/api/v1/loadmaster/8/", "service_groups": ["/api/v1/servicegroup/35/", "/api/v1/servicegroup/38/", "/api/v1/servicegroup/39/", "/api/v1/servicegroup/40/"], "source": "admin", "status_uri": null, "system_status": "UP", "updated_at": "2018-08-15T07:32:21", "valid_parent_networks": [{"cidr": 24, "id": 3, "iprange": "10.35.29.0", "nickname": null, "resource_uri": "/api/v1/network/3/"}], "version": "7.1.35.4.15528.RELEASE", "warn_host_syslog": ""}], "network": 1, "nickname": null, "resource_uri": "/api/v1/network/3/", "updated_at": "2018-08-14T07:49:26"}Show the Status of all Networks
You can use a GET method to retrieve details of the network(s).
/api/v1/network/?&api_key=APIKey&username=UsernameThe next example retrieves a full list of details for all networks that were added to Kemp 360 Central.
Example Command
curl -k --dump-header - -X GET "https://Kemp360CentralIPAddress/api/v1/network/?api_key=179d4f59c5ef97e7b6f7035eb296cdcefcc1e88f&username=admin"Expected Output
HTTP/1.1 200 OKDate: Wed, 15 Aug 2018 07:41:26 GMTServer: ApacheX-Frame-Options: SAMEORIGINCache-Control: no-cacheVary: AcceptTransfer-Encoding: chunkedContent-Type: application/json{"meta": {"limit": 1000, "next": null, "offset": 0, "previous": null, "total_count": 2}, "objects": [{"cidr": 0, "created_at": "2018-01-31T08:26:10", "id": 1, "info": {"broadcast": "255.255.255.255", "hosts": 4294967294, "max": "255.255.255.254", "min": "0.0.0.1", "netmask": "0.0.0.0", "wildcard": "255.255.255.255"}, "iprange": "0.0.0.0", "loadmasters": [], "network": 0, "nickname": "All Networks", "resource_uri": "/api/v1/network/1/", "updated_at": "2018-01-31T08:26:10"}, {"cidr": 24, "created_at": "2018-08-14T07:49:26", "id": 3, "info": {"broadcast": "10.35.29.255", "hosts": 254, "max": "10.35.29.254", "min": "10.35.29.1", "netmask": "255.255.255.0", "wildcard": "0.0.0.255"}, "iprange": "10.35.29.0", "loadmasters": [{"asl_instance": true, "aws_lb_name": null, "aws_region": null, "capabilities": {"backup": {"read": true, "write": true}, "device_config": {"read": true, "write": true}, "firmware": {"read": true, "write": true}, "logs": {"read": true, "write": true}, "reboot": {"read": true, "write": true}, "restore": {"read": true, "write": true}, "shutdown": {"read": true, "write": true}, "stats": {"read": true, "write": false}, "templates": {"read": true, "write": true}, "virtual_services": {"read": true, "write": true}}, "client_cert": true, "cluster_members": [], "cluster_node": null, "created_at": "2018-08-14T08:08:46", "critical_host_syslog": "", "datahash": "b'\\x8c\\x89?\\x8c\\x8f\\xb2\\x10\\xfb\\x84\\xa7\\xe58\\x8f9\\x96\\xf3\\xfb\\xe9S\\x17'", "device_type": 1, "emergency_host_syslog": "", "error_host_syslog": "", "ha_mode": 0, "ha_status": "", "ha_type": "", "id": 5, "info_host_syslog": "10.35.29.120", "ip_address": "10.35.29.3", "last_stats": null, "last_stats_time": "2018-08-14T08:08:46", "last_up": "2018-08-15T07:41:03", "lmusername": null, "management_interface": 0, "network": "/api/v1/network/3/", "nickname": null, "notice_host_syslog": "", "port": 443, "public_access_address": "", "resource_uri": "/api/v1/loadmaster/5/", "service_groups": ["/api/v1/servicegroup/33/", "/api/v1/servicegroup/34/"], "source": "admin", "status_uri": null, "system_status": "UP", "updated_at": "2018-08-14T09:42:07", "valid_parent_networks": [{"cidr": 24, "id": 3, "iprange": "10.35.29.0", "nickname": null, "resource_uri": "/api/v1/network/3/"}], "version": "7.2.40.0.15707.RELEASE", "warn_host_syslog": ""}, {"asl_instance": false, "aws_lb_name": null, "aws_region": null, "capabilities": {"backup": {"read": true, "write": false}, "device_config": {"read": true, "write": true}, "firmware": {"read": true, "write": false}, "logs": {"read": true, "write": false}, "reboot": {"read": true, "write": false}, "restore": {"read": true, "write": false}, "shutdown": {"read": true, "write": false}, "stats": {"read": true, "write": false}, "templates": {"read": true, "write": false}, "virtual_services": {"read": true, "write": false}}, "client_cert": true, "cluster_members": [], "cluster_node": null, "created_at": "2018-08-15T07:32:20", "critical_host_syslog": "", "datahash": "b'\\x19O\\xfb\\x86\\x88\\x90\\n\\xd9Nu^\\x8a\\x99\\xa5C\\x9e!pKK'", "device_type": 1, "emergency_host_syslog": "", "error_host_syslog": "", "ha_mode": 0, "ha_status": "", "ha_type": "", "id": 8, "info_host_syslog": "10.35.29.120", "ip_address": "10.35.29.138", "last_stats": null, "last_stats_time": "2018-08-15T07:32:17", "last_up": "2018-08-15T07:41:03", "lmusername": null, "management_interface": 0, "network": "/api/v1/network/3/", "nickname": null, "notice_host_syslog": "", "port": 443, "public_access_address": "", "resource_uri": "/api/v1/loadmaster/8/", "service_groups": ["/api/v1/servicegroup/35/", "/api/v1/servicegroup/38/", "/api/v1/servicegroup/39/", "/api/v1/servicegroup/40/"], "source": "admin", "status_uri": null, "system_status": "UP", "updated_at": "2018-08-15T07:32:21", "valid_parent_networks": [{"cidr": 24, "id": 3, "iprange": "10.35.29.0", "nickname": null, "resource_uri": "/api/v1/network/3/"}], "version": "7.1.35.4.15528.RELEASE", "warn_host_syslog": ""}], "network": 1, "nickname": null, "resource_uri": "/api/v1/network/3/", "updated_at": "2018-08-14T07:49:26"}]}Add a Network
You can use the POST method to add a new network to Kemp 360 Central.
/api/v1/network/?&api_key=APIKey&username=UsernameExample Command
curl -X POST "https://Kemp360CentralIPAddress/api/v1/network/?api_key=1d2046ad8e89a301edca3ce1cc5152fae949a216&username=admin" -H "Content-Type: application/json" -k –v -d "{\"iprange\":\"10.154.50.0\",\"cidr\":\"16\"}"Available Parameters
|
Parameter |
Parameter Type |
Parameter Description |
|---|---|---|
|
nickname |
String |
A friendly name for the network. |
|
CIDR |
Integer |
The Classless Inter-Domain Routing (CIDR) number of the network. |
|
id |
Integer |
The unique ID number of the network. The network is automatically assigned the next increment of available ID numbers. Kemp recommends not setting the ID number as it is set automatically when a network is added. |
|
iprange |
String |
The starting IP address of the network in the format IPAddress:CIDR. |
|
network |
Integer |
Optional; To make the network a sub-network of another network, specify the relevant network or sub-network ID in this parameter. |
Expected Output
HTTP/1.1 201 CREATEDDate: Mon, 05 Mar 2018 11:38:24 GMTServer: ApacheVary: AcceptX-Frame-Options: SAMEORIGINLocation: https://Kemp360CentralIPAddress/api/v1/network/2/Transfer-Encoding: chunkedContent-Type: application/json{"cidr": 16, "created_at": "2018-03-05T11:38:24.369962", "id": 2, "info": {"broadcast": "10.154.255.255", "hosts": 65534, "max": "10.154.255.254", "min": "10.154.0.1", "netmask": "255.255.0.0", "wildcard": "0.0.255.255"}, "iprange": "10.154.0.0", "loadmasters": [], "network": 1, "nickname": null, "resource_uri": "/api/v1/network/2/", "updated_at": "2018-03-05T11:38:24.370000"}Update a Network
You can use the PUT method to update the details of a network.
/api/v1/network/NetworkID/?&api_key=de26b104526be42ec7e0454d363345a15be4c453&username=UsernameExample Command
curl -X PUT "https://Kemp360CentralIPAddress/api/v1/network/2/?api_key=1d2046ad8e89a301edca3ce1cc5152fae949a216&username=admin" -H "Content-Type: application/json" -k –v -d "{\"nickname\":\"Production\"}" Available Parameters
|
Parameter |
Parameter Type |
Parameter Description |
|---|---|---|
|
nickname |
String |
A friendly name for the network. |
|
CIDR |
Integer |
The CIDR number of the network. |
|
id |
Integer |
The unique ID number of the network. The network is automatically assigned the next increment of available ID numbers. Kemp recommends not setting the ID number because it is set automatically when a network is added. |
|
loadmasters |
Related |
Details about the LoadMasters that have been added to the network. |
Expected Output
HTTP/1.1 200 OKDate: Mon, 05 Mar 2018 11:41:21 GMTServer: ApacheX-Frame-Options: SAMEORIGINVary: AcceptTransfer-Encoding: chunkedContent-Type: application/json{"cidr": 16, "created_at": "2018-03-05T11:38:24", "id": 2, "info": {"broadcast": "10.154.255.255", "hosts": 65534, "max": "10.154.255.254", "min": "10.154.0.1", "netmask": "255.255.0.0", "wildcard": "0.0.255.255"}, "iprange": "10.154.0.0", "loadmasters": [], "network": 1, "nickname": "Production", "pk": "2", "resource_uri": "/api/v1/network/2/", "updated_at": "2018-03-05T11:41:21.540755"}Delete a Network
You can use the DELETE method to remove a network from Kemp 360 Central.
/api/v1/network/NetworkID/?&api_key=APIKey&username=UsernameExample Command
curl -k --dump-header - -X DELETE "https://Kemp360CentralIPAddress/api/v1/network/13/?api_key=179d4f59c5ef97e7b6f7035eb296cdcefcc1e88f&username=admin"Expected Output
HTTP/1.1 204 NO CONTENTDate: Fri, 02 Mar 2018 11:28:44 GMTServer: ApacheX-Frame-Options: SAMEORIGINVary: AcceptContent-Length: 0Content-Type: text/html; charset=utf-8