check_point.mgmt.cp_mgmt_radius_server (5.2.3) — module

Install collection

Install with ansible-galaxy collection install check_point.mgmt:==5.2.3

Add to requirements.yml

  collections:
    - name: check_point.mgmt
      version: 5.2.3

Description

Manages radius-server objects on Checkpoint devices including creating, updating and removing objects.

All operations are performed over Web Services API.

Usage examples

Scanned by Steampunk Spotter

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

- name: add-radius-server
  cp_mgmt_radius_server:
    name: radServer
    server: hostRad
    shared_secret: '123'
    state: present

Scanned by Steampunk Spotter

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

- name: set-radius-server
  cp_mgmt_radius_server:
    name: t4
    server: hostRadius
    state: present

Scanned by Steampunk Spotter

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

- name: delete-radius-server
  cp_mgmt_radius_server:
    ignore_warnings: 'true'
    name: radiusServer
    state: absent

Inputs

    
name:
    description:
    - Object name.
    required: true
    type: str

tags:
    description:
    - Collection of tag identifiers.
    elements: str
    type: list

color:
    choices:
    - aquamarine
    - black
    - blue
    - crete blue
    - burlywood
    - cyan
    - dark green
    - khaki
    - orchid
    - dark orange
    - dark sea green
    - pink
    - turquoise
    - dark blue
    - firebrick
    - brown
    - forest green
    - gold
    - dark gold
    - gray
    - dark gray
    - light green
    - lemon chiffon
    - coral
    - sea green
    - sky blue
    - magenta
    - purple
    - slate blue
    - violet red
    - navy blue
    - olive
    - orange
    - red
    - sienna
    - yellow
    description:
    - Color of the object. Should be one of existing colors.
    type: str

state:
    choices:
    - present
    - absent
    default: present
    description:
    - State of the access rule (present or absent).
    type: str

groups:
    description:
    - Collection of group identifiers.
    elements: str
    type: list

server:
    description:
    - The UID or Name of the host that is the RADIUS Server.
    type: str

service:
    description:
    - The UID or Name of the Service to which the RADIUS server listens.
    type: str

version:
    description:
    - Version of checkpoint. If not given one, the latest version taken.
    type: str

comments:
    description:
    - Comments string.
    type: str

priority:
    description:
    - The priority of the RADIUS Server in case it is a member of a RADIUS Group.
    type: int

protocol:
    choices:
    - PAP
    - MS_CHAP2
    description:
    - The type of authentication protocol that will be used when authenticating the user
      to the RADIUS server.
    type: str

accounting:
    description:
    - Accounting settings.
    suboptions:
      accounting_service:
        description:
        - The UID or Name of the the accounting interface to notify the server when users
          login and logout which will then lock and release the IP addresses that the
          server allocated to those users.
        type: str
      enable_ip_pool_management:
        description:
        - IP pool management, enables Accounting service.
        type: bool
    type: dict

details_level:
    choices:
    - uid
    - standard
    - full
    description:
    - The level of detail for some of the fields in the response can vary from showing
      only the UID value of the object to a fully detailed representation of the object.
    type: str

ignore_errors:
    description:
    - Apply changes ignoring errors. You won't be able to publish such a changes. If ignore-warnings
      flag was omitted - warnings will also be ignored.
    type: bool

shared_secret:
    description:
    - The secret between the RADIUS server and the Security Gateway.
    type: str

wait_for_task:
    default: true
    description:
    - Wait for the task to end. Such as publish task.
    type: bool

server_version:
    choices:
    - RADIUS Ver. 1.0
    - RADIUS Ver. 2.0
    description:
    - The version can be either RADIUS Version 1.0, which is RFC 2138 compliant, and RADIUS
      Version 2.0 which is RFC 2865 compliant.
    type: str

ignore_warnings:
    description:
    - Apply changes ignoring warnings.
    type: bool

auto_publish_session:
    default: false
    description:
    - Publish the current session if changes have been performed after task completes.
    type: bool

wait_for_task_timeout:
    default: 30
    description:
    - How many minutes to wait until throwing a timeout error.
    type: int

Outputs

cp_mgmt_radius_server:
  description: The checkpoint object created or updated.
  returned: always, except when deleting the object.
  type: dict