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

Install Ansible via pip

Install with pip install ansible==2.9.17

Description

Manages application-site 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-application-site
  cp_mgmt_application_site:
    additional_categories:
    - Instant Chat
    - Supports Streaming
    - New Application Site Category 1
    description: My Application Site
    name: New Application Site 1
    primary_category: Social Networking
    state: present
    url_list:
    - www.cnet.com
    - www.stackoverflow.com
    urls_defined_as_regular_expression: false

Scanned by Steampunk Spotter

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

- name: set-application-site
  cp_mgmt_application_site:
    description: My New Application Site
    name: New Application Site 1
    primary_category: Instant Chat
    state: present
    urls_defined_as_regular_expression: true

Scanned by Steampunk Spotter

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

- name: delete-application-site
  cp_mgmt_application_site:
    name: New Application Site 2
    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

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

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

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

comments:
    description:
    - Comments string.
    type: str

url_list:
    description:
    - URLs that determine this particular application.
    type: list

description:
    description:
    - A description for the application.
    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

primary_category:
    description:
    - Each application is assigned to one primary category based on its most defining
      aspect.
    type: str

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

additional_categories:
    description:
    - Used to configure or edit the additional categories of a custom application / site
      used in the Application and URL Filtering or Threat Prevention.
    type: list

application_signature:
    description:
    - Application signature generated by <a href="https,//supportcenter.checkpoint.com/supportcenter/portal?eventSubmit_doGoviewsolutiondetails=&solutionid=sk103051">Signature
      Tool</a>.
    type: str

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

urls_defined_as_regular_expression:
    description:
    - States whether the URL is defined as a Regular Expression or not.
    type: bool

Outputs

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