apis » mgmt.til.networking » 1.0
Riverbed Networking Service v1.0
Created Nov 12, 2024 at 10:02 PM

Resource: interfaces

http://{device}/api/mgmt.til.networking/1.0/interfaces
  • JSON
    • {
  "items": [
    string
  ],
  <prop>: any
}
    Property Name Type Description Notes
    interfaces <object>
    interfaces.items <array of <string>> Optional;
    interfaces.items[items] <string>
    interfaces.<prop> <any> Optional;

    interfaces: get

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

    Returns an interfaces data object.

    Resource: interface

    http://{device}/api/mgmt.til.networking/1.0/interfaces/items/{name}
  • JSON
    • {
  "name": string,
  "configuration": configuration,
  "state": state,
  <prop>: any
}
    Property Name Type Description Notes
    interface <object>
    interface.name <string> Read-only; Optional;
    interface.configuration <configuration>
    interface.state <state> Read-only;
    interface.<prop> <any> Optional;

    interface: get

    GET http://{device}/api/mgmt.til.networking/1.0/interfaces/items/{name}
    Response Body

    Returns an interface data object.

    interface: set

    PUT http://{device}/api/mgmt.til.networking/1.0/interfaces/items/{name}
    Request Body

    Provide an interface data object.

    Response Body

    Returns an interface data object.

    Relations

    interface: instances

    Related resource

    interfaces

    Resource: ipv4_routes

    http://{device}/api/mgmt.til.networking/1.0/routes/ipv4
  • JSON
    • {
  "all": [ route_type ],
  "static": [
    {
      "id": string,
      "network_prefix": string,
      "gateway_address": string,
      "interface": string,
      <prop>: any
    }
  ],
  <prop>: any
}
    Property Name Type Description Notes
    ipv4_routes <object>
    ipv4_routes.all <array of <route_type>> Optional;
    ipv4_routes.all[items] <route_type>
    ipv4_routes.static <array of <items>> Optional;
    items <object> Required properties: [network_prefix, gateway_address, interface];
    items.id <string> Server generated route identifier Read-only; Optional;
    items.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 For IPv6 specify prefix after slash (/).
    items.gateway_address <string> Gateway IP address
    items.interface <string> Network Interface. At least one of gateway_addresses or interfaces needs to be specified.
    items.<prop> <any> Optional;
    ipv4_routes.<prop> <any> Optional;

    ipv4_routes: get

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

    Returns an ipv4_routes data object.

    ipv4_routes: create

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

    Provide an ipv4_route data object.

    Response Body

    Returns an ipv4_route data object.

    Resource: ipv4_route

    http://{device}/api/mgmt.til.networking/1.0/routes/ipv4/{id}
  • JSON
    • {
  "id": string,
  "network_prefix": string,
  "gateway_address": string,
  "interface": string,
  <prop>: any
}
    Property Name Type Description Notes
    ipv4_route <object> Required properties: [network_prefix, gateway_address, interface];
    ipv4_route.id <string> Server generated route identifier Read-only; Optional;
    ipv4_route.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 For IPv6 specify prefix after slash (/).
    ipv4_route.gateway_address <string> Gateway IP address
    ipv4_route.interface <string> Network Interface. At least one of gateway_addresses or interfaces needs to be specified.
    ipv4_route.<prop> <any> Optional;

    ipv4_route: get

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

    Returns an ipv4_route data object.

    ipv4_route: delete

    Delete a static route

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

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

    Relations

    ipv4_route: instances

    Related resource

    ipv4_routes

    Resource: ipv6_routes

    http://{device}/api/mgmt.til.networking/1.0/routes/ipv6
  • JSON
    • {
  "all": [ route_type ],
  "static": [
    {
      "id": string,
      "network_prefix": string,
      "gateway_address": string,
      "interface": string,
      <prop>: any
    }
  ],
  <prop>: any
}
    Property Name Type Description Notes
    ipv6_routes <object>
    ipv6_routes.all <array of <route_type>> Optional;
    ipv6_routes.all[items] <route_type>
    ipv6_routes.static <array of <items>> Optional;
    items <object> Required properties: [network_prefix, gateway_address, interface];
    items.id <string> Server generated route identifier Read-only; Optional;
    items.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 For IPv6 specify prefix after slash (/).
    items.gateway_address <string> Gateway IP address
    items.interface <string> Network Interface. At least one of gateway_addresses or interfaces needs to be specified.
    items.<prop> <any> Optional;
    ipv6_routes.<prop> <any> Optional;

    ipv6_routes: get

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

    Returns an ipv6_routes data object.

    ipv6_routes: create

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

    Provide an ipv6_route data object.

    Response Body

    Returns an ipv6_route data object.

    Resource: ipv6_route

    http://{device}/api/mgmt.til.networking/1.0/routes/ipv6/{id}
  • JSON
    • {
  "id": string,
  "network_prefix": string,
  "gateway_address": string,
  "interface": string,
  <prop>: any
}
    Property Name Type Description Notes
    ipv6_route <object> Required properties: [network_prefix, gateway_address, interface];
    ipv6_route.id <string> Server generated route identifier Read-only; Optional;
    ipv6_route.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 For IPv6 specify prefix after slash (/).
    ipv6_route.gateway_address <string> Gateway IP address
    ipv6_route.interface <string> Network Interface. At least one of gateway_addresses or interfaces needs to be specified.
    ipv6_route.<prop> <any> Optional;

    ipv6_route: get

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

    Returns an ipv6_route data object.

    ipv6_route: delete

    Delete a static route

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

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

    Relations

    ipv6_route: instances

    Related resource

    ipv6_routes

    Resource: route_settings

    This resource configure general route settings.

    http://{device}/api/mgmt.til.networking/1.0/settings/route
  • JSON
    • {
  "default_gateway": {
    "ipv4": string,
    "ipv6": string,
    <prop>: any
  },
  <prop>: any
}
    Property Name Type Description Notes
    route_settings <object> This resource configure general route settings.
    route_settings.default_gateway <object> Configures the default gateway for the host. The state can be verified by querying the IPv4_routes or IPv6_routes resource. 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.til.networking/1.0/settings/route
    Response Body

    Returns a route_settings data object.

    route_settings: set

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

    Provide a route_settings data object.

    Response Body

    Returns a route_settings data object.

    Type: route_type

  • JSON
    • {
  "network_prefix": string,
  "gateway_address": string,
  "interface": string,
  <prop>: any
}
    Property Name Type Description Notes
    route_type <object>
    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 For IPv6 specify prefix after slash (/). Optional;
    route_type.gateway_address <string> Gateway IP address Optional;
    route_type.interface <string> Network Interface. At least one of gateway_address or interface must be specified. Optional;
    route_type.<prop> <any> Optional;

    Type: static_route_type

  • JSON
    • {
  "id": string,
  "network_prefix": string,
  "gateway_address": string,
  "interface": string,
  <prop>: any
}
    Property Name Type Description Notes
    static_route_type <object> Required properties: [network_prefix, gateway_address, interface];
    static_route_type.id <string> Server generated route identifier Read-only; Optional;
    static_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 For IPv6 specify prefix after slash (/).
    static_route_type.gateway_address <string> Gateway IP address
    static_route_type.interface <string> Network Interface. At least one of gateway_addresses or interfaces needs to be specified.
    static_route_type.<prop> <any> Optional;

    Type: state

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

    Type: configuration

  • JSON
    • {
  "enable": boolean,
  "description": string,
  "speed": multiple,
  "duplex": multiple,
  "mtu": number,
  "ipv4": {
    "dhcp": boolean,
    "dynamic_dns": boolean,
    "address": string,
    "prefix": integer,
    <prop>: any
  },
  "ipv6": {
    "dhcp": boolean,
    "dynamic_dns": boolean,
    "address": string,
    "prefix": integer,
    <prop>: any
  },
  <prop>: any
}
    Property Name Type Description Notes
    configuration <object> Required properties: [enable, description, speed, duplex, mtu, ipv4, ipv6];
    configuration.enable <boolean>
    configuration.description <string>
    configuration.speed <multiple>
    configuration.speed.anyOf[0] <string> Set speed to the interface Values: auto, 10, 100, 1000, 2500, 10000;
    configuration.speed.anyOf[1] <null> Not configured/ Cannot be configured.
    configuration.duplex <multiple>
    configuration.duplex.anyOf[0] <string> Set duplex to the interface Values: full, half, auto;
    configuration.duplex.anyOf[1] <null> Not Configured/ Cannot be configured.
    configuration.mtu <number>
    configuration.ipv4 <object> Required properties: [dhcp, dynamic_dns, address, prefix];
    configuration.ipv4.dhcp <boolean> Obtain IP address from DHCP server.
    configuration.ipv4.dynamic_dns <boolean> Send hostname with the DHCP request.
    configuration.ipv4.address <string> Set the IPv4 address of the interface. This field is validated but not applied if DHCP is set. To disable interface IP, set address to 0.0.0.0
    configuration.ipv4.prefix <integer> Set the prefix of the interface.
    configuration.ipv4.<prop> <any> Optional;
    configuration.ipv6 <object> Required properties: [dhcp, dynamic_dns, address, prefix];
    configuration.ipv6.dhcp <boolean> Obtain IP address from DHCP server.
    configuration.ipv6.dynamic_dns <boolean> Send hostname with the DHCP request.
    configuration.ipv6.address <string> Set the IPv6 address of the interface. This field is validated but not applied if DHCP is set. To remove IPv6 address set to blank.
    configuration.ipv6.prefix <integer> IPv6 address prefix. Ignored if address is set to blank.
    configuration.ipv6.<prop> <any> Optional;
    configuration.<prop> <any> Optional;