key_pair_info_module.rst

orphan:

morpheus.core.key_pair_info module -- Gather Key Pair Information

Note

This module is part of the morpheus.core collection (version 0.7.1).

It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install morpheus.core.

To use it in a playbook, specify: morpheus.core.key_pair_info.

.. rst-class:: ansible-version-added

New in morpheus.core 0.6.0

• Synopsis
• Parameters
• Attributes
• Examples
• Return Values

Synopsis

• Gathers Information of Key Pairs.

Parameters

.. tabularcolumns:: \X{1}{3}\X{2}{3}

Parameter	Comments
.. rst-class:: ansible-option-title has_private_key .. ansible-option-type-line:: :ansible-option-type:`boolean`	Filter Key Pairs with or without a stored Private Key. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` :ansible-option-choices-entry:`false` :ansible-option-choices-entry:`true`
.. rst-class:: ansible-option-title id .. ansible-option-type-line:: :ansible-option-type:`integer`	Return specific object by id.
.. rst-class:: ansible-option-title name .. ansible-option-type-line:: :ansible-option-type:`string`	Filter by name.
.. rst-class:: ansible-option-title regex_name .. ansible-option-type-line:: :ansible-option-type:`boolean`	Treat the name parameter as a regular expression. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` :ansible-option-choices-entry-default:`false` :ansible-option-choices-default-mark:`← (default)` :ansible-option-choices-entry:`true`

Attributes

.. tabularcolumns:: \X{2}{10}\X{3}{10}\X{5}{10}

Attribute	Support	Description
.. rst-class:: ansible-option-title check_mode	:ansible-attribute-support-label:`Support: \ ` :ansible-attribute-support-na:`N/A` Not Required, Module does not make changes.	Can run in check_mode and return changed status prediction without modifying target
.. rst-class:: ansible-option-title diff_mode	:ansible-attribute-support-label:`Support: \ ` :ansible-attribute-support-na:`N/A`	Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode
.. rst-class:: ansible-option-title platform	:ansible-attribute-support-property:`Platform:` :ansible-attribute-support-full:`httpapi`	Target OS/families that can be operated against

Examples

- name: Get Specific Key by Id
  morpheus.core.key_pair_info:
    id: 20

- name: Get Keys matching Regular Expression
  morpheus.core.key_pair_info:
    name: ^morpheus_.*$
    regex_name: true

- name: Get All Keys with Private Key
  morpheus.core.key_pair_info:
    has_private_key: true

Return Values

Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:

.. tabularcolumns:: \X{1}{3}\X{2}{3}

Key

Description

.. rst-class:: ansible-option-title key_pairs .. ansible-option-type-line:: :ansible-option-type:`list` / :ansible-option-elements:`elements=string`

List of Key Pairs. .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` always .. rst-class:: ansible-option-line .. rst-class:: ansible-option-sample :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`{"key\_pairs": [{"account\_id": 1, "date\_created": "2023-07-18T08:39:48Z", "fingerprint": null, "has\_private\_key": false, "id": 1, "last\_updated": "2023-07-18T08:39:48Z", "name": "dev-ssh-key", "private\_key\_hash": null, "public\_key": "ssh-rsa AAAAB3..."}, {"account\_id": 1, "date\_created": "2023-07-18T08:39:48Z", "fingerprint": null, "has\_private\_key": false, "id": 2, "last\_updated": "2023-07-18T08:39:48Z", "name": "test-ssh-key", "private\_key\_hash": null, "public\_key": "ssh-rsa AAAAB3..."}]}`

Authors

• James Riach (@McGlovin1337)

Collection links

.. ansible-links::

  - title: "Repository (Sources)"
    url: "https://www.github.com/gomorpheus/ansible-collection-morpheus-core"
    external: true