cp_mgmt_multicast_address_range – Manages multicast-address-range objects on Check Point over Web Services API — Ansible Documentation

- AnsibleFest
- Products
- Community
- Webinars & Training
- Blog

Documentation

# cp_mgmt_multicast_address_range – Manages multicast-address-range objects on Check Point over Web Services API

New in version 2.9.

- Synopsis
- Parameters
- Examples
- Return Values
- Status

## Synopsis

- Manages multicast-address-range objects on Check Point devices including creating, updating and removing objects.
- All operations are performed over Web Services API.

## Parameters

Parameter | Choices/Defaults | Comments
--- | --- | ---
auto_publish_session boolean | Choices: no yes | Publish the current session if changes have been performed after task completes.
color string | 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 | Color of the object. Should be one of existing colors.
comments string |  | Comments string.
details_level string | Choices: uid standard full | 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.
groups list |  | Collection of group identifiers.
ignore_errors boolean | Choices: no yes | 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.
ignore_warnings boolean | Choices: no yes | Apply changes ignoring warnings.
ip_address string |  | IPv4 or IPv6 address. If both addresses are required use ipv4-address and ipv6-address fields explicitly.
ip_address_first string |  | First IP address in the range. If both IPv4 and IPv6 address ranges are required, use the ipv4-address-first and the ipv6-address-first fields instead.
ip_address_last string |  | Last IP address in the range. If both IPv4 and IPv6 address ranges are required, use the ipv4-address-first and the ipv6-address-first fields instead.
ipv4_address string |  | IPv4 address.
ipv4_address_first string |  | First IPv4 address in the range.
ipv4_address_last string |  | Last IPv4 address in the range.
ipv6_address string |  | IPv6 address.
ipv6_address_first string |  | First IPv6 address in the range.
ipv6_address_last string |  | Last IPv6 address in the range.
name string / required |  | Object name.
state string | Choices: present ← absent | State of the access rule (present or absent). Defaults to present.
tags list |  | Collection of tag identifiers.
version string |  | Version of checkpoint. If not given one, the latest version taken.
wait_for_task boolean | Choices: no yes ← | Wait for the task to end. Such as publish task.

## Examples

    - name: add-multicast-address-range
      cp_mgmt_multicast_address_range:
        ip_address_first: 224.0.0.1
        ip_address_last: 224.0.0.4
        name: New Multicast Address Range
        state: present

    - name: set-multicast-address-range
      cp_mgmt_multicast_address_range:
        ip_address_first: 224.0.0.7
        ip_address_last: 224.0.0.10
        name: New Multicast Address Range
        state: present

    - name: delete-multicast-address-range
      cp_mgmt_multicast_address_range:
        name: New Multicast Address Range
        state: absent

## Return Values

Common return values are documented here, the following are the fields unique to this module:

Key | Returned | Description
--- | --- | ---
cp_mgmt_multicast_address_range dictionary | always, except when deleting the object. | The checkpoint object created or updated.

## Status

- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]

### Authors

- Or Soffer (@chkp-orso)

Hint

If you notice any issues in this documentation, you can edit this document to improve it.