REST API for Path Selection Rules v1.0
Created Dec 18, 2020 at 07:15 PM

Resource: global_config

PS global configuration.

http://{device}/api/cmc.pathrules/1.0/global_config
  • JSON
  • {
      "path_selection": boolean,
      "path_selection_push": boolean
    }
    Property Name Type Description Notes
    global_config <object> PS global configuration.
    global_config.path_selection <boolean> This is the field for enabling/disabling PS. Optional;
    global_config.path_selection_push <boolean> This is the field for enabling/disabling PS push. Optional;
    global_config.anyOf[0] <object> Required properties: [path_selection];
    global_config.anyOf[0].<prop> <any> Optional;
    global_config.anyOf[1] <object> Required properties: [path_selection_push];
    global_config.anyOf[1].<prop> <any> Optional;

    Resource: path_rules

    Path Selection Rules collection

    http://{device}/api/cmc.pathrules/1.0/path_rules{?uplink_type_id,apptag_id,app_id}
  • JSON
  • [
      {
        "id": identifier,
        "position": position,
        "app_id": identifier,
        "apptag_id": identifier,
        "is_default": boolean,
        "uplinks": [
          {
            "uplink_type_id": integer,
            "uplink_dscp": dscp,
            "uplink_secured": boolean
          }
        ],
        "is_backhaul": boolean
      }
    ]
    Property Name Type Description Notes
    path_rules <array of <object>> Path Selection Rules collection
    path_rules[items] <object>
    path_rules[items].id <identifier> Read-only;
    path_rules[items].position <position> Position of the path rule
    path_rules[items].app_id <identifier> Read-only;
    path_rules[items].apptag_id <identifier> Read-only;
    path_rules[items].is_default <boolean> Read-only; Optional;
    path_rules[items].uplinks <array of <object>> Optional;
    path_rules[items].uplinks[items] <object>
    path_rules[items].uplinks[items].
    uplink_type_id
    <integer> Optional;
    path_rules[items].uplinks[items].
    uplink_dscp
    <dscp> DSCP integer constrained type
    path_rules[items].uplinks[items].
    uplink_secured
    <boolean> Optional;
    path_rules[items].is_backhaul <boolean> Read-only; Optional;
    path_rules[items].anyOf[0] <object> Required properties: [id];
    path_rules[items].anyOf[0].<prop> <any> Optional;
    path_rules[items].anyOf[1] <object> Required properties: [position, id];
    path_rules[items].anyOf[1].<prop> <any> Optional;
    path_rules[items].anyOf[2] <object> Required properties: [apptag_id, position, id];
    path_rules[items].anyOf[2].<prop> <any> Optional;
    path_rules[items].anyOf[3] <object> Required properties: [app_id, position, id];
    path_rules[items].anyOf[3].<prop> <any> Optional;

    Resource: path_rule

    Path-Selection Rule object

    http://{device}/api/cmc.pathrules/1.0/path_rules/items/{id}
  • JSON
  • {
      "id": identifier,
      "app_id": multiple,
      "apptag_id": multiple,
      "position": position,
      "uplinks": [
        {
          "uplink_type_id": integer,
          "uplink_dscp": dscp,
          "uplink_secured": boolean
        }
      ],
      "default_action": integer,
      "is_default": boolean,
      "is_backhaul": boolean
    }
    Property Name Type Description Notes
    path_rule <object> Path-Selection Rule object Required properties: [default_action];
    path_rule.id <identifier> Read-only;
    path_rule.app_id <multiple> Application ID. Only one of Application/ApplicationTag/group ID can be specified, not all. Optional;
    path_rule.app_id.anyOf[0] <integer>
    path_rule.app_id.anyOf[1] <null>
    path_rule.apptag_id <multiple> Application tag ID. Only one of Application/ApplicationTag/group ID can be specified, not all. Optional;
    path_rule.apptag_id.anyOf[0] <integer>
    path_rule.apptag_id.anyOf[1] <null>
    path_rule.position <position> Position of the path rule
    path_rule.uplinks <array of <object>> Uplinks specified for the rule Optional;
    path_rule.uplinks[items] <object> Required properties: [uplink_type_id, uplink_dscp];
    path_rule.uplinks[items].uplink_type_id <integer>
    path_rule.uplinks[items].uplink_dscp <dscp> DSCP integer constrained type
    path_rule.uplinks[items].uplink_secured <boolean> Optional;
    path_rule.default_action <integer> Default action to be taken in case all the links are down.
    path_rule.is_default <boolean> Is the path-selection rule a default rule? Read-only; Optional;
    path_rule.is_backhaul <boolean> Is the path-selection rule a backhaul site only rule? Read-only; Optional;

    Relations

    path_rule: instances

    Related resource

    path_rules

    path_rule: default_action

    Related resource

    default_action

    Variables
    Related var Data value for replacement
    id 0/default_action

    Resource: default_actions

    Default action resource for the Path Selection rule

    http://{device}/api/cmc.pathrules/1.0/default_actions
  • JSON
  • [
      {
        "id": identifier,
        "name": string
      }
    ]
    Property Name Type Description Notes
    default_actions <array of <items>> Default action resource for the Path Selection rule
    items <object> Required properties: [name];
    items.id <identifier> Read-only;
    items.name <string>

    Resource: default_action

    http://{device}/api/cmc.pathrules/1.0/default_actions/items/{id}
  • JSON
  • {
      "id": identifier,
      "name": string
    }
    Property Name Type Description Notes
    default_action <object> Required properties: [name];
    default_action.id <identifier> Read-only;
    default_action.name <string>

    Relations

    default_action: instances

    Related resource

    default_actions

    Resource: pathrule_status

    Path rule status of a site.

    http://{device}/api/cmc.pathrules/1.0/status{?site_id}
  • JSON
  • {
      "status": string,
      "rules": [
        {
          "id": identifier,
          "status": string
        }
      ],
      <prop>: any
    }
    Property Name Type Description Notes
    pathrule_status <object> Path rule status of a site. Read-only; Required properties: [status];
    pathrule_status.status <string> Read-only;
    pathrule_status.rules <array of <object>> Read-only; Optional;
    pathrule_status.rules[items] <object> Read-only;
    pathrule_status.rules[items].id <identifier> Read-only;
    pathrule_status.rules[items].status <string> Read-only; Optional;
    pathrule_status.<prop> <any> Read-only; Optional;

    Type: identifier

  • JSON
  • integer
    Property Name Type Description Notes
    identifier <integer> Read-only;

    Type: generic_name

    Case insensitive name

  • JSON
  • string
    Property Name Type Description Notes
    generic_name <string> Case insensitive name

    Type: dscp

    DSCP integer constrained type

  • JSON
  • integer
    Property Name Type Description Notes
    dscp <integer> DSCP integer constrained type Range: -1 to 255;

    Type: position

    Position of the path rule

  • JSON
  • integer
    Property Name Type Description Notes
    position <integer> Position of the path rule Minimum 1;