PARALLAX

cp_mgmt_radius_server

Manages radius-server objects on Checkpoint over Web Services API through native controller HTTPAPI with owned sessions

Collection: check_point.mgmt

Full Name: check_point.mgmt.cp_mgmt_radius_server

Controller module — runs on the local controller, not on remote hosts.

Synopsis

Manages radius-server objects on Checkpoint over Web Services API through native controller HTTPAPI with owned sessions

Parameters

NameTypeRequiredDefaultDescription
accountingdictAccounting settings.
auto_publish_sessionboolfalsePublish this owned session explicitly after the operation; default false.
colorstrColor of the object. Should be one of existing colors.
commentsstrComments string.
details_levelstrThe 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.
groupslistCollection of group identifiers.
ignore_errorsboolApply 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_warningsboolApply changes ignoring warnings.
namestryesObject name.
priorityintThe priority of the RADIUS Server in case it is a member of a RADIUS Group.
protocolstrThe type of authentication protocol that will be used when authenticating the user to the RADIUS server.
serverstrThe UID or Name of the host that is the RADIUS Server.
server_versionstrThe version can be either RADIUS Version 1.0, which is RFC 2138 compliant, and RADIUS Version 2.0 which is RFC 2865 compliant.
servicestrThe UID or Name of the Service to which the RADIUS server listens.
shared_secretstrThe secret between the RADIUS server and the Security Gateway.
statestrpresentDesired object presence.
tagslistCollection of tag identifiers.
versionstrManagement API version path; omitted uses the default API version.
wait_for_taskbooltrueWait for returned asynchronous task identifiers; default true.
wait_for_task_timeoutint30Polling deadline in minutes; default 30, negative values use 30, maximum 1440.

Example

yaml
- name: add-radius-server
  check_point.mgmt.cp_mgmt_radius_server:
    name: radServer
    server: hostRad
    shared_secret: '123'
    state: present

- name: set-radius-server
  check_point.mgmt.cp_mgmt_radius_server:
    name: t4
    server: hostRadius
    state: present

- name: delete-radius-server
  check_point.mgmt.cp_mgmt_radius_server:
    ignore_warnings: 'true'
    name: radiusServer
    state: absent
Search
    ↑ ↓ move↵ openesc close