fortiswitch_system_alias_command – Alias command definitions in Fortinet’s FortiSwitch

New in version 1.0.0.

Synopsis

  • This module is able to configure a FortiSwitch device by allowing the user to set and modify system_alias feature and command category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v7.0.0

Requirements

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

  • ansible>=2.11

FortiSW Version Compatibility


v7.0.0 v7.0.1 v7.0.2 v7.0.3
fortiswitch_system_alias_command yes yes yes yes

Parameters

  • enable_log - Enable/Disable logging for task. type: bool required: false default: False
  • member_path - Member attribute path to operate on. type: str
  • member_state - Add or delete a member under specified attribute path. type: str choices: present, absent
  • state - Indicates whether to create or remove the object. type: str required: true choices: present, absent
  • system_alias_command - Alias command definitions. type: dict
    • attribute - Attribute which can be retreived or modified. type: str
    • command - Script command template (use $1 for user argument). type: str
    • description - Command description and/or help message. type: str
    • limit_shown_attributes - Enable/disable limiting of config displayed in show and get. type: str choices: disable, enable
    • name - Alias name. type: str required: true
    • path - Path to configuration object or table. type: str
    • permission - Allow read and write operations, or only read operations on this path. type: str choices: read, read-write
    • read_only_attributes - Additional attributes allowed in get/show output when limit-shown-attributes is enabled. type: list
      • attribute_name - Attribute name. type: str
    • script_arguments - Optional meta-data and control values for script arguments. type: list member_path: script_arguments:id
      • allowed_values - Values to limit this argument to. type: list member_path: script_arguments:id/allowed_values:value
        • value - Allowed value. type: str required: true
      • help - A help message for the argument. type: str
      • id - Argument ID. type: int required: true
      • name - Display name for the argument. type: str
      • optional - Enable/disable the option to omit this argument. type: str choices: disable, enable
      • range - Enable/disable the option to pass a range, or list, of values for this argument. type: str choices: disable, enable
      • range_delay - When running against a range of values, delay this many seconds between values when executing. type: int
      • table_path - Path to configuration object or table. type: str
      • type - Argument data type. type: str choices: string, integer, table-id
    • table_entry_create - Allow/prevent this script from creating new entries in config tables. type: str choices: allow, deny
    • table_ids_allowed - Table entries this command is limited to. type: list
      • entry_id - Entry ID. type: str
    • table_listing - Allow/prevent listing of all entries in the config table. type: str choices: allow, deny
    • type - Command type to alias. type: str choices: configuration, script

Examples

- hosts: fortiswitch01
  collections:
    - fortinet.fortiswitch
  connection: httpapi
  vars:
   ansible_httpapi_use_ssl: yes
   ansible_httpapi_validate_certs: no
   ansible_httpapi_port: 443
  tasks:
  - name: Alias command definitions.
    fortiswitch_system_alias_command:
      state: "present"
      system_alias_command:
        attribute: "<your_own_value>"
        command: "<your_own_value>"
        description: "<your_own_value>"
        limit_shown_attributes: "disable"
        name: "default_name_7"
        path: "<your_own_value>"
        permission: "read"
        read_only_attributes:
         -
            attribute_name: "<your_own_value>"
        script_arguments:
         -
            allowed_values:
             -
                value: "<your_own_value>"
            help: "<your_own_value>"
            id:  "16"
            name: "default_name_17"
            optional: "disable"
            range: "disable"
            range_delay: "20"
            table_path: "<your_own_value>"
            type: "string"
        table_entry_create: "allow"
        table_ids_allowed:
         -
            entry_id: "<your_own_value>"
        table_listing: "allow"
        type: "configuration"

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:

  • build - Build number of the fortiSwitch image returned: always type: str sample: 1547
  • http_method - Last method used to provision the content into FortiSwitch returned: always type: str sample: PUT
  • http_status - Last result given by FortiSwitch on last operation applied returned: always type: str sample: 200
  • mkey - Master key (id) used in the last call to FortiSwitch returned: success type: str sample: id
  • name - Name of the table used to fulfill the request returned: always type: str sample: urlfilter
  • path - Path of the table used to fulfill the request returned: always type: str sample: webfilter
  • serial - Serial number of the unit returned: always type: str sample: FS1D243Z13000122
  • status - Indication of the operation's result returned: always type: str sample: success
  • version - Version of the FortiSwitch returned: always type: str sample: v7.0.0

Status

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

Authors

  • Link Zheng (@chillancezen)
  • Jie Xue (@JieX19)
  • Hongbin Lu (@fgtdev-hblu)
  • Frank Shen (@frankshen01)
  • Miguel Angel Munoz (@mamunozgonzalez)

Hint

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