PowerScale OneFS API Reference

PDF

Request query parameters

View the various query parameters for network interface API requests.


Query Parameter	Accepted Values	Description	Example
lnn	Integer	Filter the list of Network interfaces to the interfaces belonging to the specified lnns	GET /12/network/interfaces?lnn=1&lnn=2
type	Enum static dynamic smartconnect_service ipv6_link_local internal network_pool_ips all The default query returns all non IPv6 Link Local IPs.	Filter the returned IPs and owners by specifying the required IP type. To get similar results to past versions of this API, use network_pool_ips as it returns only IPs from Network Pools	GET /12/network/interfaces?type=network_pool_ips
owner	String	Filter by the specified owner ID which can be an exact match, or a partial match. An exact match is an identifier such as groupnet0.subnet0.pool0, while a partial match is 'groupnet0.subnet0'. Partial match includes the following in the output: groupnet0.subnet0.pool0 other pools in the subnet SmartConnect Service IPs configured in the subnet	GET /12/network/interfaces?owner=subnet0.pool0 GET /12/network/interfaces?owner=groupnet0.subnet.pool0 GET /12/network/interfaces?owner=groupnet0
network	Enum all external (DEFAULT) internal	Allows for specifying which network to filter results by	GET /12/network/interfaces?network=external
cache	Enum cache-only no-cache nodes-first (DEFAULT)	/12/network/interfaces by default attempts to gather live results from nodes to reply to requests. As this is not wanted, this query parameter allows the caller to specify the behavior. cache-only: Fetches results that are cached Cached results are unable to display: Mtu Gateway information SmartConnect Service IPs IPv6 Link Local IPs no-cache: Returns results from nodes that give responses. If there is no response from a node, an error occurs in the errors array. nodes-first: Queries nodes, and on failure falls back to grab results from the cache	GET /12/network/interfaces?cache=no-cache
include_vlans	Boolean. Default: true	If you do not want to see any VLAN results in the output, setting this parameter to false filters out any VLANs	GET /12/network/interfaces?include_vlans=false
vlan_id	Integer	If you want to view VLANs of a certain VLAN ID, this parameter allows you to filter the list down to the specified VLAN ID. The physical interface the VLAN is configured on, is returned.	GET /12/network/interfaces?vlan_id=101