private_access_network_configuration - Secure Private Access Resource

Added in version 1.0.0.

Synopsis

Secure Private Access Resource.

Use API “/resource-api/v1/private-access/network-configuration”.

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
  • bgp_router_ids_subnet Available/unused subnet that can be used to assign loopback interface IP addresses used for BGP router IDs parameter on the FortiSASE security PoPs. /28 is the minimum subnet size.type: str
  • as_number Autonomous System Number (ASN).type: str
  • recursive_next_hop BGP Recursive Routing. Enabling this setting allows for interhub connectivity. When use BGP design on-loopback this has to be enabled.type: bool
  • sdwan_rule_enable Hub Selection Method. Enabling this setting the highest priority service connection that meets minimum SLA requirements is selected. Otherwise BGP MED (Multi-Exit Discriminator) will be used.type: bool
  • sdwan_health_check_vm Health Check IP. Must be provided when enable sdwan rule which used to obtain Jitter, latency and packet loss measurements.type: str
  • bgp_design BGP Routing Design.type: strchoices: ['loopback', 'overlay']

Examples

- name: Private Access Network Configuration
  hosts: fortisase
  gather_facts: false
  tasks:
    - name: Create/Update Private Access Network Configuration
      fortinet.fortisase.private_access_network_configuration:
        state: present
        params:
          bgp_design: "loopback"
          bgp_router_ids_subnet: "172.1.0.0/24"
          as_number: "65400"
          sdwan_rule_enable: true
          sdwan_health_check_vm: "10.255.255.100"
          recursive_next_hop: true
    - name: Wait until the resource config_state is success
      fortinet.fortisase.fortisase_facts:
        selector: "private_access_network_configuration"
      register: result
      until: result.response.config_state == "success"
      retries: 15
      delay: 10

    # - name: Delete Private Access Network Configuration
    #   fortinet.fortisase.private_access_network_configuration:
    #     state: absent
    #     params: {}
    # - name: Wait until can't get the resource (result is empty)
    #   fortinet.fortisase.fortisase_facts:
    #     selector: "private_access_network_configuration"
    #   register: result
    #   until: result.response == {}
    #   retries: 15
    #   delay: 10

Return Values

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

Authors

• Xinwei Du (@dux-fortinet)