Skip to main content

Get Network Policy Set (v2.0)

GET 

/sdwan/v2.0/api/networkpolicysets/:policy_set_id

List a specific network policy set.

Request

Path Parameters

    policy_set_id stringrequired

    The network policy set ID.

Responses

Successful Operation

Schema
    clone_from string

    The existing policy from Network Policies for cloning the policy set.

    defaultrule_policyset boolean

    The default rule for the policy set.

    description

    The description of the network policy set. Max size = 256.

    disabled boolean

    Lists if the network policy sets are disabled.

    disabled_reason string

    Reason the network policy set is disabled.

    id string

    The network policy set ID.

    inactive boolean

    Lists if the network policy set is inactive.

    inactive_reason string

    Reason the network policy set is inactive.

    name stringrequired

    The name of the network policy set.

    policy_req_version string

    The required version of the network policy.

    policy_rules NetworkPolicyRule[]

    Lists the details of the policy rules.

  • Array [
  • app_def_ids string[]

    The app definition IDs that have applied network policy rules. The number of applications for a policy rule is limited to 256.

    description

    The description of the network policy rule. Max size = 256.

    destination_prefixes_id string

    The destination prefix ID.

    enabled boolean

    The network policy rule based on rules that are enabled.

    id string

    The network policy rule ID.

    name stringrequired

    The name of the network policy rule. Max size = 128.

    network_context_id string

    The network context applied to the network policy rule. Network context segments network traffic for the purpose of applying different network policy rules for the same application.

    order_number integer

    The network policy rule order number. The default order number for a policy rule is 1024.

    paths_allowed PathsAllowedrequired

    The paths allowed for the application.

    active_paths WANPath[]required

    The configured active path for the rule.

  • Array [
  • label string

    The label to identify the path.

    path_type stringrequired

    Possible values: [vpn, direct, servicelink]

    The path type.

  • ]
  • backup_paths WANPath[]

    The configured backup path for the rule.

  • Array [
  • label string

    The label to identify the path.

    path_type stringrequired

    Possible values: [vpn, direct, servicelink]

    The path type.

  • ]
  • l3_failure_paths WANPath[]

    The configured l3 failure path for the rule.

  • Array [
  • label string

    The label to identify the path.

    path_type stringrequired

    Possible values: [vpn, direct, servicelink]

    The path type.

  • ]
  • service_context ServiceContext

    Information on the service context.

    active_service_label_id stringrequired

    The configured active service label ID.

    active_service_label_type string

    Possible values: [CG_TRANSIT, NON_CG_TRANSIT, SASE]

    The configured active service label type.

    backup_service_label_id string

    The configured backup service label ID.

    backup_service_label_type string

    Possible values: [CG_TRANSIT, NON_CG_TRANSIT, SASE]

    The configured backup service label type.

    type stringrequired

    Possible values: [ALLOWED_TRANSIT, REQUIRED_TRANSIT]

    The type of service context.

    source_prefixes_id string

    The ID of the source prefixes.

    tags string[]

    A information field that can be added to identify the network policy rule. Maximum 10 unique tags of length 1024 each are allowed.

  • ]
  • region string

    The region of the site.

    send_to_element boolean

    Send to element.

    tags string[]

    A information field that can be added to identify the network policy set. Maximum 10 unique tags of length 1024 each are allowed.

Loading...