check_point.gaia.cp_gaia_static_route (5.0.1) — module

Install collection

Install with ansible-galaxy collection install check_point.gaia:==5.0.1

Add to requirements.yml

  collections:
    - name: check_point.gaia
      version: 5.0.1

Description

Modify the configuration of static route.

Requirements

• supported starting from gaia_api >= 1.6

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Set new static route
  check_point.gaia.cp_gaia_static_route:
    state: present
    address: 1.2.125.0
    mask_length: 24
    type: gateway
    next_hop: [{"gateway": "1.1.1.1", "priority": 2}]

Inputs

    
ping:
    default: false
    description: Configures ping monitoring of the given IPv4 static route.
    required: false
    type: bool

rank:
    description:
    - Selects a route when there are many routes to a destination that use different routing
      protocols. The route with the lowest rank value is selected. Possible values are
      0-255.
    required: false
    type: int

type:
    choices:
    - blackhole
    - gateway
    - reject
    description: Type of next hop.
    required: true
    type: str

state:
    choices:
    - present
    - absent
    default: present
    description: Ansible state which can be C(present) or C(absent).
    required: false
    type: str

address:
    description: IPv4 address.
    required: true
    type: str

comment:
    description: Static route comment.
    required: false
    type: str

version:
    description: Gaia API version for example 1.6.
    required: false
    type: str

next_hop:
    description:
    - Static next_hop. Contains a list of next-hop gateways.
    elements: dict
    required: false
    suboptions:
      gateway:
        description: IP address or logical name for the static next-hop gateway.
        required: false
        type: str
      priority:
        description:
        - Priority defines which gateway to select as the next-hop. The lower the priority,
          the higher the preference. Possible values are 1-8.
        required: false
        type: int
    type: list

mask_length:
    description: Mask length address.Valid values are 0-32.
    required: true
    type: int

scope_local:
    default: false
    description: Configure the local interface scope option, When the this option is enabled,
      the route treated as directly connected to local machine.
    required: false
    type: bool

Outputs

static_route:
  description: The checkpoint object updated.
  returned: always.
  type: dict