fmgr_fsp_vlan_dynamicmapping

New in version 2.10.

Synopsis

  • This module is able to configure a FortiManager device.
  • Examples include all parameters and values need to be adjusted to data sources before usage.

Requirements

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

  • ansible>=2.9.0

FortiManager Version Compatibility


6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0
fsp_vlan_dynamicmapping yes yes yes yes yes yes yes yes yes

Parameters

  • enable_log - Enable/Disable logging for task type: bool required: false default: False
  • forticloud_access_token - Access token of forticloud managed API users, this option is available with FortiManager later than 6.4.0 type: str required: false
  • proposed_method - The overridden method for the underlying Json RPC request type: str required: false choices: set, update, add
  • bypass_validation - Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters type: bool required: false default: False
  • workspace_locking_adom - Acquire the workspace lock if FortiManager is running in workspace mode type: str required: false choices: global, custom adom including root
  • workspace_locking_timeout - The maximum time in seconds to wait for other users to release workspace lock type: integer required: false default: 300
  • rc_succeeded - The rc codes list with which the conditions to succeed will be overriden type: list required: false
  • rc_failed - The rc codes list with which the conditions to fail will be overriden type: list required: false
  • state - The directive to create, update or delete an object type: str required: true choices: present, absent
  • adom - The parameter in requested url type: str required: true
  • vlan - The parameter in requested url type: str required: true
  • fsp_vlan_dynamicmapping - no description type: dict
    • _dhcp-status - _Dhcp-Status. type: str choices: [disable, enable] more...
    • _scope - No description for the parameter type: array more...
      • name - Name. type: str more...
      • vdom - Vdom. type: str more...
    • dhcp-server type: dict
      • auto-configuration - Enable/disable auto configuration. type: str choices: [disable, enable] more...
      • auto-managed-status - Enable/disable use of this DHCP server once this interface has been assigned an IP address from FortiIPAM. type: str choices: [disable, enable] more...
      • conflicted-ip-timeout - Time in seconds to wait after a conflicted IP address is removed from the DHCP range before it can be reused. type: int more...
      • ddns-auth - DDNS authentication mode. type: str choices: [disable, tsig] more...
      • ddns-key - DDNS update key (base 64 encoding). type: str more...
      • ddns-keyname - DDNS update key name. type: str more...
      • ddns-server-ip - DDNS server IP. type: str more...
      • ddns-ttl - TTL. type: int more...
      • ddns-update - Enable/disable DDNS update for DHCP. type: str choices: [disable, enable] more...
      • ddns-update-override - Enable/disable DDNS update override for DHCP. type: str choices: [disable, enable] more...
      • ddns-zone - Zone of your domain name (ex. type: str more...
      • default-gateway - Default gateway IP address assigned by the DHCP server. type: str more...
      • dhcp-settings-from-fortiipam - Enable/disable populating of DHCP server settings from FortiIPAM. type: str choices: [disable, enable] more...
      • dns-server1 - DNS server 1. type: str more...
      • dns-server2 - DNS server 2. type: str more...
      • dns-server3 - DNS server 3. type: str more...
      • dns-server4 - DNS server 4. type: str more...
      • dns-service - Options for assigning DNS servers to DHCP clients. type: str choices: [default, specify, local] more...
      • domain - Domain name suffix for the IP addresses that the DHCP server assigns to clients. type: str more...
      • enable - Enable. type: str choices: [disable, enable] more...
      • exclude-range - No description for the parameter type: array more...
        • end-ip - End of IP range. type: str more...
        • id - ID. type: int more...
        • start-ip - Start of IP range. type: str more...
      • filename - Name of the boot file on the TFTP server. type: str more...
      • forticlient-on-net-status - Enable/disable FortiClient-On-Net service for this DHCP server. type: str choices: [disable, enable] more...
      • id - ID. type: int more...
      • ip-mode - Method used to assign client IP. type: str choices: [range, usrgrp] more...
      • ip-range - No description for the parameter type: array more...
        • end-ip - End of IP range. type: str more...
        • id - ID. type: int more...
        • start-ip - Start of IP range. type: str more...
      • ipsec-lease-hold - DHCP over IPsec leases expire this many seconds after tunnel down (0 to disable forced-expiry). type: int more...
      • lease-time - Lease time in seconds, 0 means unlimited. type: int more...
      • mac-acl-default-action - MAC access control default action (allow or block assigning IP settings). type: str choices: [assign, block] more...
      • netmask - Netmask assigned by the DHCP server. type: str more...
      • next-server - IP address of a server (for example, a TFTP sever) that DHCP clients can download a boot file from. type: str more...
      • ntp-server1 - NTP server 1. type: str more...
      • ntp-server2 - NTP server 2. type: str more...
      • ntp-server3 - NTP server 3. type: str more...
      • ntp-service - Options for assigning Network Time Protocol (NTP) servers to DHCP clients. type: str choices: [default, specify, local] more...
      • option1 - No description for the parameter type: str more...
      • option2 - No description for the parameter type: str more...
      • option3 - No description for the parameter type: str more...
      • option4 - Option4. type: str more...
      • option5 - Option5. type: str more...
      • option6 - Option6. type: str more...
      • options - No description for the parameter type: array more...
        • code - DHCP option code. type: int more...
        • id - ID. type: int more...
        • ip - No description for the parameter type: str more...
        • type - DHCP option type. type: str choices: [hex, string, ip, fqdn] more...
        • value - DHCP option value. type: str more...
      • reserved-address - No description for the parameter type: array more...
        • action - Options for the DHCP server to configure the client with the reserved MAC address. type: str choices: [assign, block, reserved] more...
        • circuit-id - Option 82 circuit-ID of the client that will get the reserved IP address. type: str more...
        • circuit-id-type - DHCP option type. type: str choices: [hex, string] more...
        • description - Description. type: str more...
        • id - ID. type: int more...
        • ip - IP address to be reserved for the MAC address. type: str more...
        • mac - MAC address of the client that will get the reserved IP address. type: str more...
        • remote-id - Option 82 remote-ID of the client that will get the reserved IP address. type: str more...
        • remote-id-type - DHCP option type. type: str choices: [hex, string] more...
        • type - DHCP reserved-address type. type: str choices: [mac, option82] more...
      • server-type - DHCP server can be a normal DHCP server or an IPsec DHCP server. type: str choices: [regular, ipsec] more...
      • status - Enable/disable this DHCP configuration. type: str choices: [disable, enable] more...
      • tftp-server - No description for the parameter type: str more...
      • timezone - Select the time zone to be assigned to DHCP clients. type: str choices: [00, 01, 02, 03, 04, 05, 06, 07, 08, 09, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82, 83, 84, 85, 86, 87] more...
      • timezone-option - Options for the DHCP server to set the clients time zone. type: str choices: [disable, default, specify] more...
      • vci-match - Enable/disable vendor class identifier (VCI) matching. type: str choices: [disable, enable] more...
      • vci-string - No description for the parameter type: str more...
      • wifi-ac-service - Options for assigning WiFi Access Controllers to DHCP clients type: str choices: [specify, local] more...
      • wifi-ac1 - WiFi Access Controller 1 IP address (DHCP option 138, RFC 5417). type: str more...
      • wifi-ac2 - WiFi Access Controller 2 IP address (DHCP option 138, RFC 5417). type: str more...
      • wifi-ac3 - WiFi Access Controller 3 IP address (DHCP option 138, RFC 5417). type: str more...
      • wins-server1 - WINS server 1. type: str more...
      • wins-server2 - WINS server 2. type: str more...
    • interface type: dict
      • dhcp-relay-agent-option - Dhcp-Relay-Agent-Option. type: str choices: [disable, enable] more...
      • dhcp-relay-ip - No description for the parameter type: str more...
      • dhcp-relay-service - Dhcp-Relay-Service. type: str choices: [disable, enable] more...
      • dhcp-relay-type - Dhcp-Relay-Type. type: str choices: [regular, ipsec] more...
      • ip - Ip. type: str more...
      • ipv6 type: dict
        • autoconf - Enable/disable address auto config. type: str choices: [disable, enable] more...
        • dhcp6-client-options - No description for the parameter type: array choices: [rapid, iapd, iana, dns, dnsname] more...
        • dhcp6-information-request - Enable/disable DHCPv6 information request. type: str choices: [disable, enable] more...
        • dhcp6-prefix-delegation - Enable/disable DHCPv6 prefix delegation. type: str choices: [disable, enable] more...
        • dhcp6-prefix-hint - DHCPv6 prefix that will be used as a hint to the upstream DHCPv6 server. type: str more...
        • dhcp6-prefix-hint-plt - DHCPv6 prefix hint preferred life time (sec), 0 means unlimited lease time. type: int more...
        • dhcp6-prefix-hint-vlt - DHCPv6 prefix hint valid life time (sec). type: int more...
        • dhcp6-relay-ip - DHCPv6 relay IP address. type: str more...
        • dhcp6-relay-service - Enable/disable DHCPv6 relay. type: str choices: [disable, enable] more...
        • dhcp6-relay-type - DHCPv6 relay type. type: str choices: [regular] more...
        • icmp6-send-redirect - Enable/disable sending of ICMPv6 redirects. type: str choices: [disable, enable] more...
        • interface-identifier - IPv6 interface identifier. type: str more...
        • ip6-address - Primary IPv6 address prefix, syntax: xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx/xxx type: str more...
        • ip6-allowaccess - No description for the parameter type: array choices: [https, ping, ssh, snmp, http, telnet, fgfm, capwap, fabric] more...
        • ip6-default-life - Default life (sec). type: int more...
        • ip6-delegated-prefix-list - No description for the parameter type: array more...
          • autonomous-flag - Enable/disable the autonomous flag. type: str choices: [disable, enable] more...
          • onlink-flag - Enable/disable the onlink flag. type: str choices: [disable, enable] more...
          • prefix-id - Prefix ID. type: int more...
          • rdnss - No description for the parameter type: str more...
          • rdnss-service - Recursive DNS service option. type: str choices: [delegated, default, specify] more...
          • subnet - Add subnet ID to routing prefix. type: str more...
          • upstream-interface - Name of the interface that provides delegated information. type: str more...
          • delegated-prefix-iaid - IAID of obtained delegated-prefix from the upstream interface. type: int more...
        • ip6-dns-server-override - Enable/disable using the DNS server acquired by DHCP. type: str choices: [disable, enable] more...
        • ip6-extra-addr - No description for the parameter type: array more...
          • prefix - IPv6 address prefix. type: str more...
        • ip6-hop-limit - Hop limit (0 means unspecified). type: int more...
        • ip6-link-mtu - IPv6 link MTU. type: int more...
        • ip6-manage-flag - Enable/disable the managed flag. type: str choices: [disable, enable] more...
        • ip6-max-interval - IPv6 maximum interval (4 to 1800 sec). type: int more...
        • ip6-min-interval - IPv6 minimum interval (3 to 1350 sec). type: int more...
        • ip6-mode - Addressing mode (static, DHCP, delegated). type: str choices: [static, dhcp, pppoe, delegated] more...
        • ip6-other-flag - Enable/disable the other IPv6 flag. type: str choices: [disable, enable] more...
        • ip6-prefix-list - No description for the parameter type: array more...
          • autonomous-flag - Enable/disable the autonomous flag. type: str choices: [disable, enable] more...
          • dnssl - No description for the parameter type: str more...
          • onlink-flag - Enable/disable the onlink flag. type: str choices: [disable, enable] more...
          • preferred-life-time - Preferred life time (sec). type: int more...
          • prefix - IPv6 prefix. type: str more...
          • rdnss - No description for the parameter type: str more...
          • valid-life-time - Valid life time (sec). type: int more...
        • ip6-reachable-time - IPv6 reachable time (milliseconds; 0 means unspecified). type: int more...
        • ip6-retrans-time - IPv6 retransmit time (milliseconds; 0 means unspecified). type: int more...
        • ip6-send-adv - Enable/disable sending advertisements about the interface. type: str choices: [disable, enable] more...
        • ip6-subnet - Subnet to routing prefix, syntax: xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx/xxx type: str more...
        • ip6-upstream-interface - Interface name providing delegated information. type: str more...
        • nd-cert - Neighbor discovery certificate. type: str more...
        • nd-cga-modifier - Neighbor discovery CGA modifier. type: str more...
        • nd-mode - Neighbor discovery mode. type: str choices: [basic, SEND-compatible] more...
        • nd-security-level - Neighbor discovery security level (0 - 7; 0 = least secure, default = 0). type: int more...
        • nd-timestamp-delta - Neighbor discovery timestamp delta value (1 - 3600 sec; default = 300). type: int more...
        • nd-timestamp-fuzz - Neighbor discovery timestamp fuzz factor (1 - 60 sec; default = 1). type: int more...
        • unique-autoconf-addr - Enable/disable unique auto config address. type: str choices: [disable, enable] more...
        • vrip6_link_local - Link-local IPv6 address of virtual router. type: str more...
        • vrrp-virtual-mac6 - Enable/disable virtual MAC for VRRP. type: str choices: [disable, enable] more...
        • vrrp6 - No description for the parameter type: array more...
          • accept-mode - Enable/disable accept mode. type: str choices: [disable, enable] more...
          • adv-interval - Advertisement interval (1 - 255 seconds). type: int more...
          • preempt - Enable/disable preempt mode. type: str choices: [disable, enable] more...
          • priority - Priority of the virtual router (1 - 255). type: int more...
          • start-time - Startup time (1 - 255 seconds). type: int more...
          • status - Enable/disable VRRP. type: str choices: [disable, enable] more...
          • vrdst6 - Monitor the route to this destination. type: str more...
          • vrgrp - VRRP group ID (1 - 65535). type: int more...
          • vrid - Virtual router identifier (1 - 255). type: int more...
          • vrip6 - IPv6 address of the virtual router. type: str more...
        • cli-conn6-status - Cli-Conn6-Status. type: int more...
        • ip6-prefix-mode - Assigning a prefix from DHCP or RA. type: str choices: [dhcp6, ra] more...
        • ra-send-mtu - Enable/disable sending link MTU in RA packet. type: str choices: [disable, enable] more...
        • ip6-delegated-prefix-iaid - IAID of obtained delegated-prefix from the upstream interface. type: int more...
      • secondary-IP - Secondary-Ip. type: str choices: [disable, enable] more...
      • secondaryip - No description for the parameter type: array more...
        • allowaccess - No description for the parameter type: array choices: [https, ping, ssh, snmp, http, telnet, fgfm, auto-ipsec, radius-acct, probe-response, capwap, dnp, ftm, fabric, speed-test] more...
        • detectprotocol - No description for the parameter type: array choices: [ping, tcp-echo, udp-echo] more...
        • detectserver - Gateways ping server for this IP. type: str more...
        • gwdetect - Enable/disable detect gateway alive for first. type: str choices: [disable, enable] more...
        • ha-priority - HA election priority for the PING server. type: int more...
        • id - ID. type: int more...
        • ip - Secondary IP address of the interface. type: str more...
        • ping-serv-status - Ping-Serv-Status. type: int more...
        • seq - Seq. type: int more...
      • vlanid - Vlanid. type: int more...
      • dhcp-relay-interface-select-method - No description for the parameter type: str choices: [auto, sdwan, specify] more...

Notes

Note

  • Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace_locking_adom and workspace_locking_timeout help do the work.
  • To create or update an object, use state: present directive.
  • To delete an object, use state: absent directive
  • Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc_failed and rc_succeeded

Examples

- 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: no description
     fmgr_fsp_vlan_dynamicmapping:
        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>
        vlan: <your own value>
        state: <value in [present, absent]>
        fsp_vlan_dynamicmapping:
           _dhcp-status: <value in [disable, enable]>
           _scope:
             -
                 name: <value of string>
                 vdom: <value of string>
           dhcp-server:
              auto-configuration: <value in [disable, enable]>
              auto-managed-status: <value in [disable, enable]>
              conflicted-ip-timeout: <value of integer>
              ddns-auth: <value in [disable, tsig]>
              ddns-key: <value of string>
              ddns-keyname: <value of string>
              ddns-server-ip: <value of string>
              ddns-ttl: <value of integer>
              ddns-update: <value in [disable, enable]>
              ddns-update-override: <value in [disable, enable]>
              ddns-zone: <value of string>
              default-gateway: <value of string>
              dhcp-settings-from-fortiipam: <value in [disable, enable]>
              dns-server1: <value of string>
              dns-server2: <value of string>
              dns-server3: <value of string>
              dns-server4: <value of string>
              dns-service: <value in [default, specify, local]>
              domain: <value of string>
              enable: <value in [disable, enable]>
              exclude-range:
                -
                    end-ip: <value of string>
                    id: <value of integer>
                    start-ip: <value of string>
              filename: <value of string>
              forticlient-on-net-status: <value in [disable, enable]>
              id: <value of integer>
              ip-mode: <value in [range, usrgrp]>
              ip-range:
                -
                    end-ip: <value of string>
                    id: <value of integer>
                    start-ip: <value of string>
              ipsec-lease-hold: <value of integer>
              lease-time: <value of integer>
              mac-acl-default-action: <value in [assign, block]>
              netmask: <value of string>
              next-server: <value of string>
              ntp-server1: <value of string>
              ntp-server2: <value of string>
              ntp-server3: <value of string>
              ntp-service: <value in [default, specify, local]>
              option1: <value of string>
              option2: <value of string>
              option3: <value of string>
              option4: <value of string>
              option5: <value of string>
              option6: <value of string>
              options:
                -
                    code: <value of integer>
                    id: <value of integer>
                    ip: <value of string>
                    type: <value in [hex, string, ip, ...]>
                    value: <value of string>
              reserved-address:
                -
                    action: <value in [assign, block, reserved]>
                    circuit-id: <value of string>
                    circuit-id-type: <value in [hex, string]>
                    description: <value of string>
                    id: <value of integer>
                    ip: <value of string>
                    mac: <value of string>
                    remote-id: <value of string>
                    remote-id-type: <value in [hex, string]>
                    type: <value in [mac, option82]>
              server-type: <value in [regular, ipsec]>
              status: <value in [disable, enable]>
              tftp-server: <value of string>
              timezone: <value in [00, 01, 02, ...]>
              timezone-option: <value in [disable, default, specify]>
              vci-match: <value in [disable, enable]>
              vci-string: <value of string>
              wifi-ac-service: <value in [specify, local]>
              wifi-ac1: <value of string>
              wifi-ac2: <value of string>
              wifi-ac3: <value of string>
              wins-server1: <value of string>
              wins-server2: <value of string>
           interface:
              dhcp-relay-agent-option: <value in [disable, enable]>
              dhcp-relay-ip: <value of string>
              dhcp-relay-service: <value in [disable, enable]>
              dhcp-relay-type: <value in [regular, ipsec]>
              ip: <value of string>
              ipv6:
                 autoconf: <value in [disable, enable]>
                 dhcp6-client-options:
                   - rapid
                   - iapd
                   - iana
                   - dns
                   - dnsname
                 dhcp6-information-request: <value in [disable, enable]>
                 dhcp6-prefix-delegation: <value in [disable, enable]>
                 dhcp6-prefix-hint: <value of string>
                 dhcp6-prefix-hint-plt: <value of integer>
                 dhcp6-prefix-hint-vlt: <value of integer>
                 dhcp6-relay-ip: <value of string>
                 dhcp6-relay-service: <value in [disable, enable]>
                 dhcp6-relay-type: <value in [regular]>
                 icmp6-send-redirect: <value in [disable, enable]>
                 interface-identifier: <value of string>
                 ip6-address: <value of string>
                 ip6-allowaccess:
                   - https
                   - ping
                   - ssh
                   - snmp
                   - http
                   - telnet
                   - fgfm
                   - capwap
                   - fabric
                 ip6-default-life: <value of integer>
                 ip6-delegated-prefix-list:
                   -
                       autonomous-flag: <value in [disable, enable]>
                       onlink-flag: <value in [disable, enable]>
                       prefix-id: <value of integer>
                       rdnss: <value of string>
                       rdnss-service: <value in [delegated, default, specify]>
                       subnet: <value of string>
                       upstream-interface: <value of string>
                       delegated-prefix-iaid: <value of integer>
                 ip6-dns-server-override: <value in [disable, enable]>
                 ip6-extra-addr:
                   -
                       prefix: <value of string>
                 ip6-hop-limit: <value of integer>
                 ip6-link-mtu: <value of integer>
                 ip6-manage-flag: <value in [disable, enable]>
                 ip6-max-interval: <value of integer>
                 ip6-min-interval: <value of integer>
                 ip6-mode: <value in [static, dhcp, pppoe, ...]>
                 ip6-other-flag: <value in [disable, enable]>
                 ip6-prefix-list:
                   -
                       autonomous-flag: <value in [disable, enable]>
                       dnssl: <value of string>
                       onlink-flag: <value in [disable, enable]>
                       preferred-life-time: <value of integer>
                       prefix: <value of string>
                       rdnss: <value of string>
                       valid-life-time: <value of integer>
                 ip6-reachable-time: <value of integer>
                 ip6-retrans-time: <value of integer>
                 ip6-send-adv: <value in [disable, enable]>
                 ip6-subnet: <value of string>
                 ip6-upstream-interface: <value of string>
                 nd-cert: <value of string>
                 nd-cga-modifier: <value of string>
                 nd-mode: <value in [basic, SEND-compatible]>
                 nd-security-level: <value of integer>
                 nd-timestamp-delta: <value of integer>
                 nd-timestamp-fuzz: <value of integer>
                 unique-autoconf-addr: <value in [disable, enable]>
                 vrip6_link_local: <value of string>
                 vrrp-virtual-mac6: <value in [disable, enable]>
                 vrrp6:
                   -
                       accept-mode: <value in [disable, enable]>
                       adv-interval: <value of integer>
                       preempt: <value in [disable, enable]>
                       priority: <value of integer>
                       start-time: <value of integer>
                       status: <value in [disable, enable]>
                       vrdst6: <value of string>
                       vrgrp: <value of integer>
                       vrid: <value of integer>
                       vrip6: <value of string>
                 cli-conn6-status: <value of integer>
                 ip6-prefix-mode: <value in [dhcp6, ra]>
                 ra-send-mtu: <value in [disable, enable]>
                 ip6-delegated-prefix-iaid: <value of integer>
              secondary-IP: <value in [disable, enable]>
              secondaryip:
                -
                    allowaccess:
                      - https
                      - ping
                      - ssh
                      - snmp
                      - http
                      - telnet
                      - fgfm
                      - auto-ipsec
                      - radius-acct
                      - probe-response
                      - capwap
                      - dnp
                      - ftm
                      - fabric
                      - speed-test
                    detectprotocol:
                      - ping
                      - tcp-echo
                      - udp-echo
                    detectserver: <value of string>
                    gwdetect: <value in [disable, enable]>
                    ha-priority: <value of integer>
                    id: <value of integer>
                    ip: <value of string>
                    ping-serv-status: <value of integer>
                    seq: <value of integer>
              vlanid: <value of integer>
              dhcp-relay-interface-select-method: <value in [auto, sdwan, specify]>

Return Values

Common return values are documented: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:

  • request_url - The full url requested returned: always type: str sample: /sys/login/user
  • response_code - The status of api request returned: always type: int sample: 0
  • response_message - The descriptive message of the api response returned: always type: str sample: OK
  • response_data - The data body of the api response returned: optional type: list or dict

Status

  • This module is not guaranteed to have a backwards compatible interface.

Authors

  • Link Zheng (@chillancezen)
  • Jie Xue (@JieX19)
  • Frank Shen (@fshen01)
  • Hongbin Lu (@fgtdev-hblu)

Hint

If you notice any issues in this documentation, you can create a pull request to improve it.