Contains the network addresses configured for each physical NIC.

URL

GET https://<IP-address-of-SPS>/api/configuration/network/nics

Cookies

Cookie name	Description	Required	Values
session_id	Contains the authentication token of the user	Required	The value of the session ID cookie received from the REST server in the authentication response, for example, a1f71d030e657634730b9e887cb59a5e56162860. For more information on authentication, see Authenticate to the SPS REST API. NOTE: This session ID refers to the connection between the REST client and the SPS REST API. It is not related to the sessions that SPS records (and which also have a session ID, but in a different format).

Sample request

The following command lists the endpoints for the physical network interfaces.

curl --cookie cookies.txt https://<IP-address-of-SPS>/api/configuration/network/nics/

The following commands retrieve the properties of a specific physical network interface.

curl --cookie cookies.txt https://<IP-address-of-SPS>/api/configuration/network/nics/nic1

curl --cookie cookies.txt https://<IP-address-of-SPS>/api/configuration/network/nics/nic2

curl --cookie cookies.txt https://<IP-address-of-SPS>/api/configuration/network/nics/nic3

Response

The following is a sample response received when listing physical network interfaces.

For more information on the meta object, see Message format.

{
  "items": [
    {
      "key": "nic1",
      "meta": {
        "href": "/api/configuration/network/nics/nic1"
      }
    },
    {
      "key": "nic2",
      "meta": {
        "href": "/api/configuration/network/nics/nic2"
      }
    },
    {
      "key": "nic3",
      "meta": {
        "href": "/api/configuration/network/nics/nic3"
      }
    }
  ],
  "meta": {
    "first": "/api/configuration/network/dns",
    "href": "/api/configuration/network/nics",
    "last": "/api/configuration/network/routing",
    "next": "/api/configuration/network/routing",
    "parent": "/api/configuration/network",
    "previous": "/api/configuration/network/naming",
    "transaction": "/api/transaction"
  }
}

When retrieving the endpoint of a specific physical network interface, the response is the following.

{
  "body": {
      "interfaces": {
          "@order": ["ff7574025754b3df1647001"],
          "ff7574025754b3df1647001": {
              "addresses": {
                  "1": "198.51.100.123/24",
                  "6001481625b7c21ef97598": "2001:db8:1234::5678/48",
                  "@order": ["1", "6001481625b7c21ef97598"]
              },
              "mtu": 1500,
              "name": "external",
              "source_based_routes": [
                  {
                      "gateway": "198.51.100.1",
                      "target_network": "203.0.113.0/24"
                  },
                  {
                      "gateway": "2001:db8:1234::1",
                      "target_network": "2001:db8:aaaa::/48"
                  }
              ],
              "vlantag": 0
          }
      },
      "name": "eth0",
      "speed": "auto"
  },
  "key": "nic1",
  "meta": {
      "first": "/api/configuration/network/nics/nic1",
      "href": "/api/configuration/network/nics/nic1",
      "last": "/api/configuration/network/nics/nic3",
      "next": "/api/configuration/network/nics/nic2",
      "parent": "/api/configuration/network/nics",
      "previous": null,
      "remaining_seconds": 10800,
      "transaction": "/api/transaction"
  }
}

Element		Type	Description
key		string	Top level element, contains the ID of the physical network interface (nic1, nic2 or nic3).
body		Top level element (string)	Contains the properties of the physical network interface.
	interfaces	Top level item	Contains the configuration of all virtual interfaces on the physical NIC.
	name	string	The system name of the physical network interface (eth0, eth1 or eth2). Do not change this value.
	speed	string	The speed of the physical network interface. The default value is auto. Change this setting only for troubleshooting purposes. Possible values are: auto Negotiate the network speed automatically. This is the default value. 10-half 10BaseT/Half. 100-half 100BaseT/Half. 10-full 10BaseT/Full. 100-full 100BaseT/Full. 1000-full 1000BaseT/Full.

Elements of interfaces	Type			Description
@order			list	Lists the keys of the interfaces in the order they are be displayed on the SPS web UI.
<key-of-an-interface>			string	Contains the addresses, name, and vlantag of the network interface. Each physical NIC has an automatically created interface key, where the value of the vlanid element is set to 0. To add a valid virtual network interface to the physical NIC, create an additional interface, and assign a value between 1 and 4094 to its vlanid element.
	addresses		string	Contains the addresses of the interface, and their display order.
		<key-of-address>	string	Contains the IP address range.
		@order	list	Lists the keys of the addresses in the order they are displayed on the SPS web UI.
	mtu		integer	Maximum Transmission Unit (MTU) to set per network interface (VLAN or network interface card). Default value: 1500
	name		string	The name of the interface, as displayed on the SPS web UI.
	source_based_routes		list	Contains details of the network routing rule specific to packets coming out of this particular interface.
	vlantag		string	The ID of the interface. For the physical interface, the value is 0. For virtual interfaces, the value is between 1 and 4094. Caution: Do not set the VLAN ID unless your network environment is already configured to use this VLAN. Otherwise, your SPS appliance will be unavailable using this interface.

Elements of source_based_routes	Type	Description
gateway	string	The IPv4 or IPv6 address of the gateway used to access the network set in this routing rule.
target_network	string	The IPv4 or IPv6 address of the host or network accessible via this routing rule.

Status and error codes

The following table lists the typical status and error codes for this request. For a complete list of error codes, see Application level error codes.

Code	Description	Notes
401	Unauthenticated	The requested resource cannot be retrieved because the client is not authenticated and the resource requires authorization to access it. The details section contains the path that was attempted to be accessed, but could not be retrieved.
403	Unauthorized	The requested resource cannot be retrieved because the client is not authorized to access it. The details section contains the path that was attempted to be accessed, but could not be retrieved.
404	NotFound	The requested object does not exist.