.. Document meta :orphan: .. |antsibull-internal-nbsp| unicode:: 0xA0 :trim: .. meta:: :antsibull-docs: 2.26.0 .. Anchors .. _ansible_collections.stephrobert.scaleway.lb_frontend_acl_info_module: .. Anchors: short name for ansible.builtin .. Title stephrobert.scaleway.lb_frontend_acl_info module -- Gather information about Scaleway Load Balancer frontend ACLs +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: This module is part of the `stephrobert.scaleway collection `_ (version 0.7.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. To install it, use: :code:`ansible\-galaxy collection install stephrobert.scaleway`. You need further requirements to be able to use this module, see :ref:`Requirements ` for details. To use it in a playbook, specify: :code:`stephrobert.scaleway.lb_frontend_acl_info`. .. version_added .. rst-class:: ansible-version-added New in stephrobert.scaleway 0.1.0 .. contents:: :local: :depth: 1 .. Deprecated Synopsis -------- .. Description - List the ACLs for a given frontend, specified by its frontend ID. The response is an array of ACL objects, each one representing an ACL that denies or allows traffic based on certain conditions. .. Aliases .. Requirements .. _ansible_collections.stephrobert.scaleway.lb_frontend_acl_info_module_requirements: Requirements ------------ The below requirements are needed on the host that executes this module. - scaleway \>= 2.9.0 .. Options Parameters ---------- .. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 :class: longtable ansible-option-table * - Parameter - Comments * - .. raw:: html
.. _ansible_collections.stephrobert.scaleway.lb_frontend_acl_info_module__parameter-access_key: .. rst-class:: ansible-option-title **access_key** .. raw:: html .. ansible-option-type-line:: :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Scaleway API access key. .. raw:: html
* - .. raw:: html
.. _ansible_collections.stephrobert.scaleway.lb_frontend_acl_info_module__parameter-api_allow_insecure: .. rst-class:: ansible-option-title **api_allow_insecure** .. raw:: html .. ansible-option-type-line:: :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Allow the API endpoint to be reached without verifying its TLS certificate. Falls back to the Scaleway configuration file, then to :literal:`false`. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.stephrobert.scaleway.lb_frontend_acl_info_module__parameter-api_timeout: .. rst-class:: ansible-option-title **api_timeout** .. raw:: html .. ansible-option-type-line:: :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Seconds allowed for a single API call, connection and read. Without a limit a silent connection would hang the module forever: the Scaleway SDK issues its requests with no timeout at all. This bounds a single call, not a whole wait. Modules that can wait for a state bound the overall wait separately. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`60` .. raw:: html
* - .. raw:: html
.. _ansible_collections.stephrobert.scaleway.lb_frontend_acl_info_module__parameter-api_url: .. rst-class:: ansible-option-title **api_url** .. raw:: html .. ansible-option-type-line:: :ansible-option-type:`string` .. raw:: html
- .. raw:: html
URL of the Scaleway API endpoint. Point it at a local emulator to exercise a playbook without credentials. Falls back to the Scaleway configuration file, then to :literal:`https://api.scaleway.com`. It carries no module default on purpose: a default is never unset, so it would always override the profile. .. raw:: html
* - .. raw:: html
.. _ansible_collections.stephrobert.scaleway.lb_frontend_acl_info_module__parameter-config_file: .. rst-class:: ansible-option-title **config_file** .. raw:: html .. ansible-option-type-line:: :ansible-option-type:`path` .. raw:: html
- .. raw:: html
Path to the Scaleway configuration file. .. raw:: html
* - .. raw:: html
.. _ansible_collections.stephrobert.scaleway.lb_frontend_acl_info_module__parameter-frontend_id: .. rst-class:: ansible-option-title **frontend_id** .. raw:: html .. ansible-option-type-line:: :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
- .. raw:: html
Frontend ID (ACLs attached to this frontend will be returned in the response). .. raw:: html
* - .. raw:: html
.. _ansible_collections.stephrobert.scaleway.lb_frontend_acl_info_module__parameter-name: .. rst-class:: ansible-option-title **name** .. raw:: html .. ansible-option-type-line:: :ansible-option-type:`string` .. raw:: html
- .. raw:: html
ACL name to filter for. .. raw:: html
* - .. raw:: html
.. _ansible_collections.stephrobert.scaleway.lb_frontend_acl_info_module__parameter-order_by: .. rst-class:: ansible-option-title **order_by** .. raw:: html .. ansible-option-type-line:: :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Sort order of ACLs in the response. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`"created\_at\_asc"` - :ansible-option-choices-entry:`"created\_at\_desc"` - :ansible-option-choices-entry:`"name\_asc"` - :ansible-option-choices-entry:`"name\_desc"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.stephrobert.scaleway.lb_frontend_acl_info_module__parameter-organization_id: .. rst-class:: ansible-option-title **organization_id** .. raw:: html .. ansible-option-type-line:: :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Default Organization ID used when an operation does not name one. .. raw:: html
* - .. raw:: html
.. _ansible_collections.stephrobert.scaleway.lb_frontend_acl_info_module__parameter-profile: .. rst-class:: ansible-option-title **profile** .. raw:: html .. ansible-option-type-line:: :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Name of the profile to read in the Scaleway configuration file. .. raw:: html
* - .. raw:: html
.. _ansible_collections.stephrobert.scaleway.lb_frontend_acl_info_module__parameter-project_id: .. rst-class:: ansible-option-title **project_id** .. raw:: html .. ansible-option-type-line:: :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Default Project ID used when an operation does not name one. .. raw:: html
* - .. raw:: html
.. _ansible_collections.stephrobert.scaleway.lb_frontend_acl_info_module__parameter-secret_key: .. rst-class:: ansible-option-title **secret_key** .. raw:: html .. ansible-option-type-line:: :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Scaleway API secret key. .. raw:: html
* - .. raw:: html
.. _ansible_collections.stephrobert.scaleway.lb_frontend_acl_info_module__parameter-user_agent: .. rst-class:: ansible-option-title **user_agent** .. raw:: html .. ansible-option-type-line:: :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Value of the User\-Agent header sent to the API. .. raw:: html
* - .. raw:: html
.. _ansible_collections.stephrobert.scaleway.lb_frontend_acl_info_module__parameter-zone: .. rst-class:: ansible-option-title **zone** .. raw:: html .. ansible-option-type-line:: :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
- .. raw:: html
The zone you want to target .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`"fr\-par\-1"` - :ansible-option-choices-entry:`"fr\-par\-2"` - :ansible-option-choices-entry:`"nl\-ams\-1"` - :ansible-option-choices-entry:`"nl\-ams\-2"` - :ansible-option-choices-entry:`"nl\-ams\-3"` - :ansible-option-choices-entry:`"pl\-waw\-1"` - :ansible-option-choices-entry:`"pl\-waw\-2"` - :ansible-option-choices-entry:`"pl\-waw\-3"` .. raw:: html
.. Attributes Attributes ---------- .. tabularcolumns:: \X{2}{10}\X{3}{10}\X{5}{10} .. list-table:: :width: 100% :widths: auto :header-rows: 1 :class: longtable ansible-option-table * - Attribute - Support - Description * - .. raw:: html
.. _ansible_collections.stephrobert.scaleway.lb_frontend_acl_info_module__attribute-check_mode: .. rst-class:: ansible-option-title **check_mode** .. raw:: html .. raw:: html
- .. raw:: html
:ansible-attribute-support-label:`Support: \ `\ :ansible-attribute-support-full:`full` .. raw:: html
- .. raw:: html
This module only reads, so check mode changes nothing about how it runs. .. raw:: html
* - .. raw:: html
.. _ansible_collections.stephrobert.scaleway.lb_frontend_acl_info_module__attribute-diff_mode: .. rst-class:: ansible-option-title **diff_mode** .. raw:: html .. raw:: html
- .. raw:: html
:ansible-attribute-support-label:`Support: \ `\ :ansible-attribute-support-none:`none` .. raw:: html
- .. raw:: html
This module changes nothing, so it has no difference to report. .. raw:: html
.. Notes Notes ----- .. note:: - Every option can be set from its environment variable, respectively :literal:`SCW\_PROFILE`\ , :literal:`SCW\_CONFIG\_PATH`\ , :literal:`SCW\_ACCESS\_KEY`\ , :literal:`SCW\_SECRET\_KEY`\ , :literal:`SCW\_API\_URL`\ , :literal:`SCW\_DEFAULT\_ORGANIZATION\_ID` and :literal:`SCW\_DEFAULT\_PROJECT\_ID`. - Module options take precedence over environment variables, which take precedence over the configuration file. .. Seealso .. Examples Examples -------- .. code-block:: yaml+jinja # This module only reads: it never changes anything, and check mode # is native. - name: List ACLs for a given frontend stephrobert.scaleway.lb_frontend_acl_info: zone: fr-par-1 frontend_id: 11111111-2222-3333-4444-555555555555 register: result - name: Filter Scaleway Load Balancer frontend ACLs by name stephrobert.scaleway.lb_frontend_acl_info: zone: fr-par-1 frontend_id: 11111111-2222-3333-4444-555555555555 name: my-frontend-acl-info register: result .. Facts .. Return values Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: .. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 :class: longtable ansible-option-table * - Key - Description * - .. raw:: html
.. _ansible_collections.stephrobert.scaleway.lb_frontend_acl_info_module__return-acls: .. rst-class:: ansible-option-title **acls** .. raw:: html .. ansible-option-type-line:: :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html
- .. raw:: html
List the ACLs for a given frontend, specified by its frontend ID. The response is an array of ACL objects, each one representing an ACL that denies or allows traffic based on certain conditions. .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` success .. raw:: html
* - .. raw:: html
.. raw:: latex \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} .. _ansible_collections.stephrobert.scaleway.lb_frontend_acl_info_module__return-acls/action: .. rst-class:: ansible-option-title **action** .. raw:: html .. ansible-option-type-line:: :ansible-option-type:`dictionary` .. raw:: html
.. raw:: latex \end{minipage} - .. raw:: html
Action to take when incoming traffic matches an ACL filter. .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` when the API returns it .. raw:: html
* - .. raw:: html
.. raw:: latex \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} .. _ansible_collections.stephrobert.scaleway.lb_frontend_acl_info_module__return-acls/created_at: .. rst-class:: ansible-option-title **created_at** .. raw:: html .. ansible-option-type-line:: :ansible-option-type:`string` .. raw:: html
.. raw:: latex \end{minipage} - .. raw:: html
Date on which the ACL was created. (RFC 3339 format) .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` when the API returns it .. raw:: html
* - .. raw:: html
.. raw:: latex \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} .. _ansible_collections.stephrobert.scaleway.lb_frontend_acl_info_module__return-acls/description: .. rst-class:: ansible-option-title **description** .. raw:: html .. ansible-option-type-line:: :ansible-option-type:`string` .. raw:: html
.. raw:: latex \end{minipage} - .. raw:: html
ACL description. .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` when the API returns it .. raw:: html
* - .. raw:: html
.. raw:: latex \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} .. _ansible_collections.stephrobert.scaleway.lb_frontend_acl_info_module__return-acls/frontend: .. rst-class:: ansible-option-title **frontend** .. raw:: html .. ansible-option-type-line:: :ansible-option-type:`dictionary` .. raw:: html
.. raw:: latex \end{minipage} - .. raw:: html
ACL is attached to this frontend object. .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` when the API returns it .. raw:: html
* - .. raw:: html
.. raw:: latex \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} .. _ansible_collections.stephrobert.scaleway.lb_frontend_acl_info_module__return-acls/id: .. rst-class:: ansible-option-title **id** .. raw:: html .. ansible-option-type-line:: :ansible-option-type:`string` .. raw:: html
.. raw:: latex \end{minipage} - .. raw:: html
ACL ID. .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` when the API returns it .. raw:: html
* - .. raw:: html
.. raw:: latex \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} .. _ansible_collections.stephrobert.scaleway.lb_frontend_acl_info_module__return-acls/index: .. rst-class:: ansible-option-title **index** .. raw:: html .. ansible-option-type-line:: :ansible-option-type:`integer` .. raw:: html
.. raw:: latex \end{minipage} - .. raw:: html
Priority of this ACL (ACLs are applied in ascending order, 0 is the first ACL executed). .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` when the API returns it .. raw:: html
* - .. raw:: html
.. raw:: latex \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} .. _ansible_collections.stephrobert.scaleway.lb_frontend_acl_info_module__return-acls/match: .. rst-class:: ansible-option-title **match** .. raw:: html .. ansible-option-type-line:: :ansible-option-type:`dictionary` .. raw:: html
.. raw:: latex \end{minipage} - .. raw:: html
ACL match filter object. One of \`ip\_subnet\`, \`ips\_edge\_services\` or \`http\_filter\` & \`http\_filter\_value\` are required. .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` when the API returns it .. raw:: html
* - .. raw:: html
.. raw:: latex \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} .. _ansible_collections.stephrobert.scaleway.lb_frontend_acl_info_module__return-acls/name: .. rst-class:: ansible-option-title **name** .. raw:: html .. ansible-option-type-line:: :ansible-option-type:`string` .. raw:: html
.. raw:: latex \end{minipage} - .. raw:: html
ACL name. .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` when the API returns it .. raw:: html
* - .. raw:: html
.. raw:: latex \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} .. _ansible_collections.stephrobert.scaleway.lb_frontend_acl_info_module__return-acls/updated_at: .. rst-class:: ansible-option-title **updated_at** .. raw:: html .. ansible-option-type-line:: :ansible-option-type:`string` .. raw:: html
.. raw:: latex \end{minipage} - .. raw:: html
Date on which the ACL was last updated. (RFC 3339 format) .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` when the API returns it .. raw:: html
.. Status (Presently only deprecated) .. Authors Authors ~~~~~~~ - Stéphane Robert (@stephrobert) .. Extra links Collection links ~~~~~~~~~~~~~~~~ .. ansible-links:: - title: "Issue Tracker" url: "https://github.com/stephrobert/collection-scaleway/issues" external: true - title: "Repository (Sources)" url: "https://github.com/stephrobert/collection-scaleway" external: true .. Parsing errors