ansible.builtin.cp_mgmt_administrator (v2.9.17) — module

Install Ansible via pip

Install with pip install ansible==2.9.17

Description

Manages administrator objects on Check Point 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-administrator
  cp_mgmt_administrator:
    authentication_method: INTERNAL_PASSWORD
    email: admin@gmail.com
    must_change_password: false
    name: admin
    password: secret
    permissions_profile: read write all
    phone_number: 1800-800-800
    state: present

Scanned by Steampunk Spotter

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

- name: set-administrator
  cp_mgmt_administrator:
    name: admin
    password: bew secret
    permissions_profile: read only profile
    state: present

Scanned by Steampunk Spotter

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

- name: delete-administrator
  cp_mgmt_administrator:
    name: admin
    state: absent

Inputs

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

tags:
    description:
    - Collection of tag identifiers.
    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

email:
    description:
    - Administrator email.
    type: str

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

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

comments:
    description:
    - Comments string.
    type: str

password:
    description:
    - Administrator password.
    type: str

phone_number:
    description:
    - Administrator phone number.
    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

password_hash:
    description:
    - Administrator password hash.
    type: str

radius_server:
    description:
    - RADIUS server object identified by the name or UID. Must be set when "authentication-method"
      was selected to be "RADIUS".
    type: str

tacacs_server:
    description:
    - TACACS server object identified by the name or UID. Must be set when "authentication-method"
      was selected to be "TACACS".
    type: str

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

expiration_date:
    description:
    - Format, YYYY-MM-DD, YYYY-mm-ddThh,mm,ss.
    type: str

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

permissions_profile:
    description:
    - Administrator permissions profile. Permissions profile should not be provided when
      multi-domain-profile is set to "Multi-Domain Super User" or "Domain Super User".
    suboptions:
      profile:
        description:
        - Permission profile.
        type: str
    type: list

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

multi_domain_profile:
    description:
    - Administrator multi-domain profile.
    type: str

must_change_password:
    description:
    - True if administrator must change password on the next login.
    type: bool

authentication_method:
    choices:
    - undefined
    - check point password
    - os password
    - securid
    - radius
    - tacacs
    - ad authentication
    description:
    - Authentication method.
    type: str

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

Outputs

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