apis » mgmt.networking » 1.1
Management networking configuration v1.1
Created Mar 27, 2024 at 07:04 PM

Resource: capabilities

The capabilities of an interface

http://{device}/api/mgmt.networking/1.1/interfaces/{name}/capabilities
  • JSON
    • {
  "autoneg": boolean,
  "speed_duplex": [
    string
  ],
  <prop>: any
}
    Property Name Type Description Notes
    capabilities <object> The capabilities of an interface
    capabilities.autoneg <boolean> Whether Auto-negotiation is available Optional;
    capabilities.speed_duplex <array of <string>> The speed and duplex combinations available on this interface Optional;
    capabilities.speed_duplex[items] <string> A speed and duplex combination
    capabilities.<prop> <any> Optional;

    capabilities: get

    GET http://{device}/api/mgmt.networking/1.1/interfaces/{name}/capabilities
    Response Body

    Returns a capabilities data object.

    Resource: host_settings

    General networking setting for the host machine, including the hostname, name servers, and domain names. 

    http://{device}/api/mgmt.networking/1.1/settings/host
  • JSON
    • {
  "dns_domains": [
    string
  ],
  "dns_servers": [
    string
  ],
  "hostname": string,
  "hosts": [
    {
      "hostname": string,
      "ip_address": string,
      <prop>: any
    }
  ],
  <prop>: any
}
    Property Name Type Description Notes
    host_settings <object> General networking setting for the host machine, including the hostname, name servers, and domain names.
    host_settings.dns_domains <array of <string>> Ordered list of domain names to append when attempting hostname resolution. If DHCP is enabled, these domains will be prepended to any returned by the DHCP server. Optional;
    host_settings.dns_domains[items] <string> A single domain name
    host_settings.dns_servers <array of <string>> Ordered list of DNS server IP addresses. A maximum of three servers may be configured. If DHCP is enabled, these servers will be prepended to any returned by the DHCP server. Optional;
    host_settings.dns_servers[items] <string> A single DNS server IP address
    host_settings.hostname <string> Hostname of the device Optional;
    host_settings.hosts <array of <object>> Additional host entries Optional;
    host_settings.hosts[items] <object> A single host to IP mapping
    host_settings.hosts[items].hostname <string> The hostname to associate with this IP address Optional;
    host_settings.hosts[items].ip_address <string> The IP address of the host Optional;
    host_settings.hosts[items].<prop> <any> Optional;
    host_settings.<prop> <any> Optional;

    host_settings: get

    GET http://{device}/api/mgmt.networking/1.1/settings/host
    Response Body

    Returns a host_settings data object.

    host_settings: set

    PUT http://{device}/api/mgmt.networking/1.1/settings/host
    Request Body

    Provide a host_settings data object.

    Response Body

    Returns a host_settings data object.

    Resource: host_state

    The host settings applied to the system, both from values configured in host_settings as well as provided by DHCP, if enabled 

    http://{device}/api/mgmt.networking/1.1/host_state
  • JSON
    • {
  "dns_domains": [
    string
  ],
  "dns_servers": [
    string
  ],
  "ipv4_default_gateway": string,
  "ipv6_default_gateway": string
}
    Property Name Type Description Notes
    host_state <object> The host settings applied to the system, both from values configured in host_settings as well as provided by DHCP, if enabled Required properties: [ipv4_default_gateway, ipv6_default_gateway, dns_servers, dns_domains];
    host_state.dns_domains <array of <string>> Ordered list of domain names to append when attempting hostname resolution.
    host_state.dns_domains[items] <string> A single domain name
    host_state.dns_servers <array of <string>> Ordered list of DNS server IP addresses
    host_state.dns_servers[items] <string> A single DNS server IP address
    host_state.ipv4_default_gateway <string> The IPv4 default gateway
    host_state.ipv6_default_gateway <string> The IPv6 default gateway

    host_state: get

    GET http://{device}/api/mgmt.networking/1.1/host_state
    Response Body

    Returns a host_state data object.

    Resource: interface

    Configuration and current status of a management interface

    http://{device}/api/mgmt.networking/1.1/interfaces/{name}
  • JSON
    • {
  "configuration": configuration,
  "name": string,
  "state": state,
  <prop>: any
}
    Property Name Type Description Notes
    interface <object> Configuration and current status of a management interface
    interface.configuration <configuration> Interface configuration
    interface.name <string> Interface name Read-only; Optional;
    interface.state <state> Current interface state Read-only;
    interface.<prop> <any> Optional;

    interface: get

    GET http://{device}/api/mgmt.networking/1.1/interfaces/{name}
    Response Body

    Returns an interface data object.

    interface: renew

    Renew all DHCP leases for this interface. Will return an error if DHCP is not enabled. 

    POST http://{device}/api/mgmt.networking/1.1/interfaces/{name}/renew_dhcp
    Request Body

    Provide a request body with the following structure:

    Property Name Type Description Notes
    interface.links.renew.request <number> DHCP version to renew Values: 4, 6;
    Response Body

    On success, the server does not provide any body in the responses.

    interface: set

    PUT http://{device}/api/mgmt.networking/1.1/interfaces/{name}
    Request Body

    Provide an interface data object.

    Response Body

    Returns an interface data object.

    Relations

    interface: capabilities

    The capabilities of this interface

    Related resource

    capabilities

    Variables
    Related var Data value for replacement
    name 0/name

    interface: instances

    All available management interfaces

    Related resource

    interface

    Resource: interfaces

    Management interfaces available on this device

    http://{device}/api/mgmt.networking/1.1/interfaces
  • JSON
    • [
  string
]
    Property Name Type Description Notes
    interfaces <array of <string>> Management interfaces available on this device
    interfaces[items] <string> The name of an available management interface

    interfaces: get

    GET http://{device}/api/mgmt.networking/1.1/interfaces
    Response Body

    Returns an interfaces data object.

    Resource: ipv4_route

    A single IPv4 route

    http://{device}/api/mgmt.networking/1.1/routes/ipv4/{id}
  • JSON
    • {
  "gateway_address": string,
  "id": number,
  "interface": string,
  "network_prefix": string,
  <prop>: any
}
    Property Name Type Description Notes
    ipv4_route <object> A single IPv4 route Required properties: [network_prefix, gateway_address, interface];
    ipv4_route.gateway_address <string> Gateway IP address
    ipv4_route.id <number> Route ID Read-only; Optional;
    ipv4_route.interface <string> Network interface. At least one of "gateway_address" or "interface needs" to be specified.
    ipv4_route.network_prefix <string> Destination network prefix. A string consisting of an IPv4 address and a mask, separated by a slash (/). For example, "192.168.1.0/24" or "192.168.1.0/255.255.255.0"
    ipv4_route.<prop> <any> Optional;

    ipv4_route: delete

    DELETE http://{device}/api/mgmt.networking/1.1/routes/ipv4/{id}
    Response Body

    On success, the server does not provide any body in the responses.

    ipv4_route: get

    GET http://{device}/api/mgmt.networking/1.1/routes/ipv4/{id}
    Response Body

    Returns an ipv4_route data object.

    ipv4_route: set

    PUT http://{device}/api/mgmt.networking/1.1/routes/ipv4/{id}
    Request Body

    Provide an ipv4_route data object.

    Response Body

    Returns an ipv4_route data object.

    Relations

    ipv4_route: instances

    All IPv4 routes

    Related resource

    ipv4_routes

    Resource: ipv4_routes

    Configured IPv4 routes

    http://{device}/api/mgmt.networking/1.1/routes/ipv4
  • JSON
    • {
  "all": [ route_type ],
  "static": [
    {
      "gateway_address": string,
      "id": number,
      "interface": string,
      "network_prefix": string,
      <prop>: any
    }
  ],
  <prop>: any
}
    Property Name Type Description Notes
    ipv4_routes <object> Configured IPv4 routes
    ipv4_routes.all <array of <route_type>> All configured IPv4 routes, including default gateway. Optional;
    ipv4_routes.all[items] <route_type> A route
    ipv4_routes.static <array of <items>> Static, manually configured IPv4 routes. Optional;
    items <object> A single IPv4 route Required properties: [network_prefix, gateway_address, interface];
    items.gateway_address <string> Gateway IP address
    items.id <number> Route ID Read-only; Optional;
    items.interface <string> Network interface. At least one of "gateway_address" or "interface needs" to be specified.
    items.network_prefix <string> Destination network prefix. A string consisting of an IPv4 address and a mask, separated by a slash (/). For example, "192.168.1.0/24" or "192.168.1.0/255.255.255.0"
    items.<prop> <any> Optional;
    ipv4_routes.<prop> <any> Optional;

    ipv4_routes: create

    POST http://{device}/api/mgmt.networking/1.1/routes/ipv4
    Request Body

    Provide an ipv4_route data object.

    Response Body

    Returns an ipv4_route data object.

    ipv4_routes: get

    GET http://{device}/api/mgmt.networking/1.1/routes/ipv4
    Response Body

    Returns an ipv4_routes data object.

    Resource: ipv6_route

    A single Ipv6 route

    http://{device}/api/mgmt.networking/1.1/routes/ipv6/{id}
  • JSON
    • {
  "gateway_address": string,
  "id": number,
  "interface": string,
  "network_prefix": string,
  <prop>: any
}
    Property Name Type Description Notes
    ipv6_route <object> A single Ipv6 route Required properties: [network_prefix, gateway_address, interface];
    ipv6_route.gateway_address <string> Gateway IP address
    ipv6_route.id <number> Route ID Read-only; Optional;
    ipv6_route.interface <string> Network interface. At least one of "gateway_address" or "interface needs" to be specified.
    ipv6_route.network_prefix <string> Destination network prefix. A string consisting of an IP address and prefix, separated by a slash (/).
    ipv6_route.<prop> <any> Optional;

    ipv6_route: delete

    DELETE http://{device}/api/mgmt.networking/1.1/routes/ipv6/{id}
    Response Body

    On success, the server does not provide any body in the responses.

    ipv6_route: get

    GET http://{device}/api/mgmt.networking/1.1/routes/ipv6/{id}
    Response Body

    Returns an ipv6_route data object.

    ipv6_route: set

    PUT http://{device}/api/mgmt.networking/1.1/routes/ipv6/{id}
    Request Body

    Provide an ipv6_route data object.

    Response Body

    Returns an ipv6_route data object.

    Relations

    ipv6_route: instances

    All IPv6 routes

    Related resource

    ipv6_routes

    Resource: ipv6_routes

    Configured IPv6 routes

    http://{device}/api/mgmt.networking/1.1/routes/ipv6
  • JSON
    • {
  "all": [ route_type ],
  "static": [
    {
      "gateway_address": string,
      "id": number,
      "interface": string,
      "network_prefix": string,
      <prop>: any
    }
  ],
  <prop>: any
}
    Property Name Type Description Notes
    ipv6_routes <object> Configured IPv6 routes
    ipv6_routes.all <array of <route_type>> All configured IPv6 routes Optional;
    ipv6_routes.all[items] <route_type> A route
    ipv6_routes.static <array of <items>> Static, manually configured IPv6 routes. Optional;
    items <object> A single Ipv6 route Required properties: [network_prefix, gateway_address, interface];
    items.gateway_address <string> Gateway IP address
    items.id <number> Route ID Read-only; Optional;
    items.interface <string> Network interface. At least one of "gateway_address" or "interface needs" to be specified.
    items.network_prefix <string> Destination network prefix. A string consisting of an IP address and prefix, separated by a slash (/).
    items.<prop> <any> Optional;
    ipv6_routes.<prop> <any> Optional;

    ipv6_routes: create

    POST http://{device}/api/mgmt.networking/1.1/routes/ipv6
    Request Body

    Provide an ipv6_route data object.

    Response Body

    Returns an ipv6_route data object.

    ipv6_routes: get

    GET http://{device}/api/mgmt.networking/1.1/routes/ipv6
    Response Body

    Returns an ipv6_routes data object.

    Resource: route_settings

    Global route settings

    http://{device}/api/mgmt.networking/1.1/settings/route
  • JSON
    • {
  "default_gateway": {
    "ipv4": string,
    "ipv6": string,
    <prop>: any
  },
  <prop>: any
}
    Property Name Type Description Notes
    route_settings <object> Global route settings
    route_settings.default_gateway <object> The default gateway configuration for the host. Ignored if DHCP is enabled. The state can be verified by quering the "ipv4_routes" or "ipv6_routes" resources. Optional;
    route_settings.default_gateway.ipv4 <string> IPv4 address for default gateway. Blank string unsets it. Optional;
    route_settings.default_gateway.ipv6 <string> IPv6 address for default gateway. Blank string unsets it. Optional;
    route_settings.default_gateway.<prop> <any> Optional;
    route_settings.<prop> <any> Optional;

    route_settings: get

    GET http://{device}/api/mgmt.networking/1.1/settings/route
    Response Body

    Returns a route_settings data object.

    route_settings: set

    PUT http://{device}/api/mgmt.networking/1.1/settings/route
    Request Body

    Provide a route_settings data object.

    Response Body

    Returns a route_settings data object.

    Type: configuration

    Interface configuration

  • JSON
    • {
  "autoneg": multiple,
  "description": string,
  "duplex": multiple,
  "enable": boolean,
  "ipv4": {
    "address": string,
    "dhcp": boolean,
    "dynamic_dns": boolean,
    "subnet_mask": string,
    <prop>: any
  },
  "ipv6": {
    "address": string,
    "dhcp": boolean,
    "dynamic_dns": boolean,
    "prefix": string,
    <prop>: any
  },
  "mtu": number,
  "speed": multiple,
  <prop>: any
}
    Property Name Type Description Notes
    configuration <object> Interface configuration
    configuration.autoneg <multiple> Optional;
    configuration.autoneg.anyOf[0] <boolean> Auto-negotiation enabled
    configuration.autoneg.anyOf[1] <null> Not configured, or does not apply to this interface
    configuration.description <string> Interface description Optional;
    configuration.duplex <multiple> Optional;
    configuration.duplex.anyOf[0] <string> Interface duplex setting. Ignored if "autoneg" is True. Values: full, half;
    configuration.duplex.anyOf[1] <null> Not configured, or does not apply to this interface
    configuration.enable <boolean> Interface enabled Optional;
    configuration.ipv4 <object> Optional;
    configuration.ipv4.address <string> Set the IPv4 address of the interface. This field is validated but not applied if DHCP is enabled. To disable an interface IP, set address to 0.0.0.0. Optional;
    configuration.ipv4.dhcp <boolean> Obtain IP address via DHCP Optional;
    configuration.ipv4.dynamic_dns <boolean> Send hostname with the DHCP request Optional;
    configuration.ipv4.subnet_mask <string> Set the subnet mask of the interface. This field is validated but not applied if DHCP is enabled. Cleared if address is set to 0.0.0.0. Optional;
    configuration.ipv4.<prop> <any> Optional;
    configuration.ipv6 <object> Optional;
    configuration.ipv6.address <string> Set the IPv6 address of the interface. This field is validated but not applied if DHCP is enabled. Remove the IPv6 address by setting this field to an empty string. Optional;
    configuration.ipv6.dhcp <boolean> Obtain IP address via DHCP Optional;
    configuration.ipv6.dynamic_dns <boolean> Send hostname with the DHCP request Optional;
    configuration.ipv6.prefix <string> The IPv6 address prefix. This field is validated but not applied if DHCP is enabled, or the address is not set. Optional;
    configuration.ipv6.<prop> <any> Optional;
    configuration.mtu <number> Interface MTU Optional;
    configuration.speed <multiple> Optional;
    configuration.speed.anyOf[0] <number> Speed to force this interface to run at. Ignored if "autoneg" is True. Values: 10, 100, 1000, 2500, 10000;
    configuration.speed.anyOf[1] <null> Not configured, or does not apply to this interface
    configuration.<prop> <any> Optional;

    Type: route_type

    A route

  • JSON
    • {
  "gateway_address": string,
  "interface": string,
  "network_prefix": string,
  <prop>: any
}
    Property Name Type Description Notes
    route_type <object> A route
    route_type.gateway_address <string> Gateway IP address Optional;
    route_type.interface <string> Network interface. At least one of "gateway_address" or "interface" needs to be specified. Optional;
    route_type.network_prefix <string> Destination network prefix. A string consisting of an IP address and a mask, separated by a slash (/). For example, "192.168.1.0/24" or "192.168.1.0/255.255.255.0". For ipv6 specify prefix after slash (/). Optional;
    route_type.<prop> <any> Optional;

    Type: state

    Current interface state

  • JSON
    • {
  "autoneg": multiple,
  "duplex": multiple,
  "enabled": boolean,
  "hw_address": string,
  "if_index": number,
  "interface_type": string,
  "ipv4": {
    "address": string,
    "subnet_mask": string,
    <prop>: any
  },
  "ipv6": {
    "address": string,
    "link_local": string,
    <prop>: any
  },
  "link": boolean,
  "mtu": number,
  "speed": multiple,
  <prop>: any
}
    Property Name Type Description Notes
    state <object> Current interface state Read-only;
    state.autoneg <multiple> Read-only; Optional;
    state.autoneg.anyOf[0] <boolean> Auto-negotiation status Read-only;
    state.autoneg.anyOf[1] <null> Auto-negotiation is not relevant for this interface Read-only;
    state.duplex <multiple> Read-only; Optional;
    state.duplex.anyOf[0] <string> Interface duplex Read-only;
    state.duplex.anyOf[1] <null> Duplex is not relevant for this interface Read-only;
    state.enabled <boolean> Interface enabled/up Read-only; Optional;
    state.hw_address <string> Interface hardware address Read-only; Optional;
    state.if_index <number> Interface index Read-only; Optional;
    state.interface_type <string> Interface type Read-only; Optional;
    state.ipv4 <object> Read-only; Optional;
    state.ipv4.address <string> Interface IPv4 address Read-only; Optional;
    state.ipv4.subnet_mask <string> Subnet mask Read-only; Optional;
    state.ipv4.<prop> <any> Read-only; Optional;
    state.ipv6 <object> Read-only; Optional;
    state.ipv6.address <string> Interface IPv6 address Read-only; Optional;
    state.ipv6.link_local <string> Link local IPv6 address Read-only; Optional;
    state.ipv6.<prop> <any> Read-only; Optional;
    state.link <boolean> Interface link state Read-only; Optional;
    state.mtu <number> Interface MTU Read-only; Optional;
    state.speed <multiple> Read-only; Optional;
    state.speed.anyOf[0] <string> Interface speed Read-only;
    state.speed.anyOf[1] <null> Speed is not relevant for this interface Read-only;
    state.<prop> <any> Read-only; Optional;