drmofu.fortimanager.fmgr_hotspot20_hsprofile (2.2.2) — module

Install collection

Install with ansible-galaxy collection install drmofu.fortimanager:==2.2.2

Add to requirements.yml

  collections:
    - name: drmofu.fortimanager
      version: 2.2.2

Description

This module is able to configure a FortiManager device.

Examples include all parameters and values which need to be adjusted to data sources before usage.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

 - hosts: fortimanager-inventory
   collections:
     - fortinet.fortimanager
   connection: httpapi
   vars:
      ansible_httpapi_use_ssl: True
      ansible_httpapi_validate_certs: False
      ansible_httpapi_port: 443
   tasks:
    - name: Configure hotspot profile.
      fmgr_hotspot20_hsprofile:
         bypass_validation: False
         workspace_locking_adom: <value in [global, custom adom including root]>
         workspace_locking_timeout: 300
         rc_succeeded: [0, -2, -3, ...]
         rc_failed: [-2, -3, ...]
         adom: <your own value>
         state: <value in [present, absent]>
         hotspot20_hsprofile:
            3gpp-plmn: <value of string>
            access-network-asra: <value in [disable, enable]>
            access-network-esr: <value in [disable, enable]>
            access-network-internet: <value in [disable, enable]>
            access-network-type: <value in [private-network, private-network-with-guest-access, chargeable-public-network, ...]>
            access-network-uesa: <value in [disable, enable]>
            anqp-domain-id: <value of integer>
            bss-transition: <value in [disable, enable]>
            conn-cap: <value of string>
            deauth-request-timeout: <value of integer>
            dgaf: <value in [disable, enable]>
            domain-name: <value of string>
            gas-comeback-delay: <value of integer>
            gas-fragmentation-limit: <value of integer>
            hessid: <value of string>
            ip-addr-type: <value of string>
            l2tif: <value in [disable, enable]>
            nai-realm: <value of string>
            name: <value of string>
            network-auth: <value of string>
            oper-friendly-name: <value of string>
            osu-provider: <value of string>
            osu-ssid: <value of string>
            pame-bi: <value in [disable, enable]>
            proxy-arp: <value in [disable, enable]>
            qos-map: <value of string>
            roaming-consortium: <value of string>
            venue-group: <value in [unspecified, assembly, business, ...]>
            venue-name: <value of string>
            venue-type: <value in [unspecified, arena, stadium, ...]>
            wan-metrics: <value of string>
            wnm-sleep-mode: <value in [disable, enable]>
            advice-of-charge: <value of string>
            oper-icon: <value of string>
            osu-provider-nai: <value of string>
            release: <value of integer>
            terms-and-conditions: <value of string>
            venue-url: <value of string>

Inputs

    
adom:
    description: the parameter (adom) in requested url
    required: true
    type: str

state:
    choices:
    - present
    - absent
    description: The directive to create, update or delete an object.
    required: true
    type: str

rc_failed:
    description: The rc codes list with which the conditions to fail will be overriden.
    elements: int
    required: false
    type: list

enable_log:
    default: false
    description: Enable/Disable logging for task.
    required: false
    type: bool

access_token:
    description: The token to access FortiManager without using username and password.
    required: false
    type: str

rc_succeeded:
    description: The rc codes list with which the conditions to succeed will be overriden.
    elements: int
    required: false
    type: list

proposed_method:
    choices:
    - update
    - set
    - add
    description: The overridden method for the underlying Json RPC request.
    required: false
    type: str

bypass_validation:
    default: false
    description: Only set to True when module schema diffs with FortiManager API structure,
      module continues to execute without validating parameters.
    required: false
    type: bool

hotspot20_hsprofile:
    description: the top level parameters set
    required: false
    suboptions:
      3gpp-plmn:
        description: 3GPP PLMN name.
        type: str
      access-network-asra:
        choices:
        - disable
        - enable
        description: Enable/disable additional step required for access
        type: str
      access-network-esr:
        choices:
        - disable
        - enable
        description: Enable/disable emergency services reachable
        type: str
      access-network-internet:
        choices:
        - disable
        - enable
        description: Enable/disable connectivity to the Internet.
        type: str
      access-network-type:
        choices:
        - private-network
        - private-network-with-guest-access
        - chargeable-public-network
        - free-public-network
        - personal-device-network
        - emergency-services-only-network
        - test-or-experimental
        - wildcard
        description: Access network type.
        type: str
      access-network-uesa:
        choices:
        - disable
        - enable
        description: Enable/disable unauthenticated emergency service accessible
        type: str
      advice-of-charge:
        description: Advice of charge.
        type: str
      anqp-domain-id:
        description: ANQP Domain ID
        type: int
      bss-transition:
        choices:
        - disable
        - enable
        description: Enable/disable basic service set
        type: str
      conn-cap:
        description: Connection capability name.
        type: str
      deauth-request-timeout:
        description: Deauthentication request timeout
        type: int
      dgaf:
        choices:
        - disable
        - enable
        description: Enable/disable downstream group-addressed forwarding
        type: str
      domain-name:
        description: Domain name.
        type: str
      gas-comeback-delay:
        description: GAS comeback delay
        type: int
      gas-fragmentation-limit:
        description: GAS fragmentation limit
        type: int
      hessid:
        description: Homogeneous extended service set identifier
        type: str
      ip-addr-type:
        description: IP address type name.
        type: str
      l2tif:
        choices:
        - disable
        - enable
        description: Enable/disable Layer 2 traffic inspection and filtering.
        type: str
      nai-realm:
        description: NAI realm list name.
        type: str
      name:
        description: Hotspot profile name.
        type: str
      network-auth:
        description: Network authentication name.
        type: str
      oper-friendly-name:
        description: Operator friendly name.
        type: str
      oper-icon:
        description: Operator icon.
        type: str
      osu-provider:
        description: Manually selected list of OSU provider
        type: str
      osu-provider-nai:
        description: OSU Provider NAI.
        type: str
      osu-ssid:
        description: Online sign up
        type: str
      pame-bi:
        choices:
        - disable
        - enable
        description: Enable/disable Pre-Association Message Exchange BSSID Independent
        type: str
      proxy-arp:
        choices:
        - disable
        - enable
        description: Enable/disable Proxy ARP.
        type: str
      qos-map:
        description: QoS MAP set ID.
        type: str
      release:
        description: Hotspot 2.
        type: int
      roaming-consortium:
        description: Roaming consortium list name.
        type: str
      terms-and-conditions:
        description: Terms and conditions.
        type: str
      venue-group:
        choices:
        - unspecified
        - assembly
        - business
        - educational
        - factory
        - institutional
        - mercantile
        - residential
        - storage
        - utility
        - vehicular
        - outdoor
        description: Venue group.
        type: str
      venue-name:
        description: Venue name.
        type: str
      venue-type:
        choices:
        - unspecified
        - arena
        - stadium
        - passenger-terminal
        - amphitheater
        - amusement-park
        - place-of-worship
        - convention-center
        - library
        - museum
        - restaurant
        - theater
        - bar
        - coffee-shop
        - zoo-or-aquarium
        - emergency-center
        - doctor-office
        - bank
        - fire-station
        - police-station
        - post-office
        - professional-office
        - research-facility
        - attorney-office
        - primary-school
        - secondary-school
        - university-or-college
        - factory
        - hospital
        - long-term-care-facility
        - rehab-center
        - group-home
        - prison-or-jail
        - retail-store
        - grocery-market
        - auto-service-station
        - shopping-mall
        - gas-station
        - private
        - hotel-or-motel
        - dormitory
        - boarding-house
        - automobile
        - airplane
        - bus
        - ferry
        - ship-or-boat
        - train
        - motor-bike
        - muni-mesh-network
        - city-park
        - rest-area
        - traffic-control
        - bus-stop
        - kiosk
        description: Venue type.
        type: str
      venue-url:
        description: Venue name.
        type: str
      wan-metrics:
        description: WAN metric name.
        type: str
      wnm-sleep-mode:
        choices:
        - disable
        - enable
        description: Enable/disable wireless network management
        type: str
    type: dict

workspace_locking_adom:
    description: The adom to lock for FortiManager running in workspace mode, the value
      can be global and others including root.
    required: false
    type: str

forticloud_access_token:
    description: Authenticate Ansible client with forticloud API access token.
    required: false
    type: str

workspace_locking_timeout:
    default: 300
    description: The maximum time in seconds to wait for other user to release the workspace
      lock.
    required: false
    type: int

Outputs

meta:
  contains:
    request_url:
      description: The full url requested.
      returned: always
      sample: /sys/login/user
      type: str
    response_code:
      description: The status of api request.
      returned: always
      sample: 0
      type: int
    response_data:
      description: The api response.
      returned: always
      type: list
    response_message:
      description: The descriptive message of the api response.
      returned: always
      sample: OK.
      type: str
    system_information:
      description: The information of the target system.
      returned: always
      type: dict
  description: The result of the request.
  returned: always
  type: dict
rc:
  description: The status the request.
  returned: always
  sample: 0
  type: int
version_check_warning:
  description: Warning if the parameters used in the playbook are not supported by
    the current FortiManager version.
  returned: complex
  type: list