auth_fsso_agents - FSSO Agent Resource

Added in version 1.0.0.

Synopsis

FSSO Agent Resource.

Use API “/resource-api/v2/auth/fsso-agents”.

Requirements

The below requirements are needed on the host that executes this module.

  • ansible>=2.17.0

Parameters

  • state The state of the module. "present" means create or update the resource, "absent" means delete the resource.type: strchoices: ['present', 'absent']default: present
  • force_behavior Specify this option to force the method to use to interact with the resource.type: strchoices: ['none', 'read', 'create', 'update', 'delete']default: none
  • bypass_validation Bypass validation of the module.type: booldefault: False
  • params The parameters of the module.[Required]type: dict
    • primary_key [Required]type: str
    • active_server type: str
    • status type: strchoices: ['connected', 'disconnected']
    • name type: str
    • server type: str
    • password type: str
    • server2 type: str
    • password2 type: str
    • server3 type: str
    • password3 type: str
    • server4 type: str
    • password4 type: str
    • server5 type: str
    • password5 type: str
    • ssl_trusted_cert type: str

Examples

- name: Auth FSSO Agent
  hosts: fortisase
  gather_facts: false
  vars:
    primary_key: "agent_example"
  tasks:
    - name: Create/Update Auth FSSO Agent
      fortinet.fortisase.auth_fsso_agents:
        state: present
        params:
          primary_key: "{{ primary_key }}"
          name: "{{ primary_key }}"
          server: "1.2.3.4"
          status: "disconnected"
          password: "password"
          ssl_trusted_cert: "remote_ca_certs"
    - name: Delete Auth FSSO Agent
      fortinet.fortisase.auth_fsso_agents:
        state: absent
        params:
          primary_key: "{{ primary_key }}"

Return Values

  • http_code type: intreturned: always
  • response type: rawreturned: always

Authors

  • Xinwei Du (@dux-fortinet)