check_point.mgmt.cp_mgmt_tacacs_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 tacacs-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-tacacs-server
  cp_mgmt_tacacs_server:
    name: tacacs7
    server: h1
    state: present

Scanned by Steampunk Spotter

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

- name: set-tacacs-server
  cp_mgmt_tacacs_server:
    encryption: 'true'
    name: tacacs server
    priority: '5'
    secret_key: '**secret**'
    server: d700e8d5-d010-4f37-ab14-f78f5a26426c
    server_type: TACACS
    state: present

Scanned by Steampunk Spotter

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

- name: delete-tacacs-server
  cp_mgmt_tacacs_server:
    name: tacacs server
    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 TACACS Server.
    type: str

service:
    description:
    - Server service, only relevant when "server-type" is TACACS.
    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 TACACS Server in case it is a member of a TACACS Group.
    type: int

encryption:
    description:
    - Is there a secret key defined on the server. Must be set true when "server-type"
      was selected to be "TACACS+".
    type: bool

secret_key:
    description:
    - The server's secret key.<br><font color="red">Required only when</font> "server-type"
      was selected to be "TACACS+".
    type: str

server_type:
    choices:
    - TACACS
    - TACACS+
    description:
    - Server type, TACACS or TACACS+.
    type: str

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

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

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_tacacs_server:
  description: The checkpoint object created or updated.
  returned: always, except when deleting the object.
  type: dict