security_pki_users - PKI User Resource

Added in version 1.0.0.

Synopsis

PKI User Resource.

Use API “/resource-api/v1/security/pki-users”.

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 Primary Key of PKI User.[Required]type: str
  • subject type: str
  • ca type: dict
    • name CA Cert Nametype: str

Examples

- name: Security PKI Users
  hosts: fortisase
  gather_facts: false
  vars:
    primary_key: "asbusers"
  tasks:
    - name: Create/Update Security PKI Users
      fortinet.fortisase.security_pki_users:
        state: present
        params:
          primary_key: "{{ primary_key }}"
          ca:
            name: "Fortinet_CA"
    - name: Delete Security PKI Users
      fortinet.fortisase.security_pki_users:
        state: absent
        params:
          primary_key: "{{ primary_key }}"

Return Values

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

Authors

• Xinwei Du (@dux-fortinet)