Online: rename _facts -> _info (#61091)
* Rename online _facts -> _info * Add changelog.
This commit is contained in:
parent
489156378c
commit
185a1fcb07
9 changed files with 285 additions and 13 deletions
3
changelogs/fragments/61091-online-facts-info.yaml
Normal file
3
changelogs/fragments/61091-online-facts-info.yaml
Normal file
|
@ -0,0 +1,3 @@
|
||||||
|
minor_changes:
|
||||||
|
- The ``online_server_facts`` module has been deprecated. Use ``online_server_info`` instead.
|
||||||
|
- The ``online_user_facts`` module has been deprecated. Use ``online_user_info`` instead.
|
|
@ -116,6 +116,10 @@ The following modules will be removed in Ansible 2.13. Please update update your
|
||||||
|
|
||||||
* nxos_vlan use :ref:`nxos_vlans <nxos_vlans_module>` instead.
|
* nxos_vlan use :ref:`nxos_vlans <nxos_vlans_module>` instead.
|
||||||
|
|
||||||
|
* online_server_facts use :ref:`online_server_info <online_server_info_module>` instead.
|
||||||
|
|
||||||
|
* online_user_facts use :ref:`online_user_info <online_user_info_module>` instead.
|
||||||
|
|
||||||
* purefa_facts use :ref:`purefa_info <purefa_info_module>` instead.
|
* purefa_facts use :ref:`purefa_info <purefa_info_module>` instead.
|
||||||
|
|
||||||
* purefb_facts use :ref:`purefb_info <purefb_info_module>` instead.
|
* purefb_facts use :ref:`purefb_info <purefb_info_module>` instead.
|
||||||
|
|
|
@ -8,12 +8,16 @@ from __future__ import (absolute_import, division, print_function)
|
||||||
__metaclass__ = type
|
__metaclass__ = type
|
||||||
|
|
||||||
ANSIBLE_METADATA = {'metadata_version': '1.1',
|
ANSIBLE_METADATA = {'metadata_version': '1.1',
|
||||||
'status': ['preview'],
|
'status': ['deprecated'],
|
||||||
'supported_by': 'community'}
|
'supported_by': 'community'}
|
||||||
|
|
||||||
DOCUMENTATION = r'''
|
DOCUMENTATION = r'''
|
||||||
---
|
---
|
||||||
module: online_server_facts
|
module: online_server_facts
|
||||||
|
deprecated:
|
||||||
|
removed_in: '2.13'
|
||||||
|
why: Deprecated in favour of C(_info) module.
|
||||||
|
alternative: Use M(online_server_info) instead.
|
||||||
short_description: Gather facts about Online servers.
|
short_description: Gather facts about Online servers.
|
||||||
description:
|
description:
|
||||||
- Gather facts about the servers.
|
- Gather facts about the servers.
|
|
@ -7,12 +7,16 @@ from __future__ import (absolute_import, division, print_function)
|
||||||
__metaclass__ = type
|
__metaclass__ = type
|
||||||
|
|
||||||
ANSIBLE_METADATA = {'metadata_version': '1.1',
|
ANSIBLE_METADATA = {'metadata_version': '1.1',
|
||||||
'status': ['preview'],
|
'status': ['deprecated'],
|
||||||
'supported_by': 'community'}
|
'supported_by': 'community'}
|
||||||
|
|
||||||
DOCUMENTATION = r'''
|
DOCUMENTATION = r'''
|
||||||
---
|
---
|
||||||
module: online_user_facts
|
module: online_user_facts
|
||||||
|
deprecated:
|
||||||
|
removed_in: '2.13'
|
||||||
|
why: Deprecated in favour of C(_info) module.
|
||||||
|
alternative: Use M(online_user_info) instead.
|
||||||
short_description: Gather facts about Online user.
|
short_description: Gather facts about Online user.
|
||||||
description:
|
description:
|
||||||
- Gather facts about the user.
|
- Gather facts about the user.
|
178
lib/ansible/modules/cloud/online/online_server_info.py
Normal file
178
lib/ansible/modules/cloud/online/online_server_info.py
Normal file
|
@ -0,0 +1,178 @@
|
||||||
|
#!/usr/bin/python
|
||||||
|
# -*- coding: utf-8 -*-
|
||||||
|
#
|
||||||
|
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
|
||||||
|
|
||||||
|
from __future__ import (absolute_import, division, print_function)
|
||||||
|
|
||||||
|
__metaclass__ = type
|
||||||
|
|
||||||
|
ANSIBLE_METADATA = {'metadata_version': '1.1',
|
||||||
|
'status': ['preview'],
|
||||||
|
'supported_by': 'community'}
|
||||||
|
|
||||||
|
DOCUMENTATION = r'''
|
||||||
|
---
|
||||||
|
module: online_server_info
|
||||||
|
short_description: Gather information about Online servers.
|
||||||
|
description:
|
||||||
|
- Gather information about the servers.
|
||||||
|
- U(https://www.online.net/en/dedicated-server)
|
||||||
|
version_added: "2.9"
|
||||||
|
author:
|
||||||
|
- "Remy Leone (@sieben)"
|
||||||
|
extends_documentation_fragment: online
|
||||||
|
'''
|
||||||
|
|
||||||
|
EXAMPLES = r'''
|
||||||
|
- name: Gather Online server information
|
||||||
|
online_server_info:
|
||||||
|
api_token: '0d1627e8-bbf0-44c5-a46f-5c4d3aef033f'
|
||||||
|
register: result
|
||||||
|
|
||||||
|
- debug:
|
||||||
|
msg: "{{ result.online_server_info }}"
|
||||||
|
'''
|
||||||
|
|
||||||
|
RETURN = r'''
|
||||||
|
---
|
||||||
|
online_server_info:
|
||||||
|
description: Response from Online API
|
||||||
|
returned: success
|
||||||
|
type: complex
|
||||||
|
contains:
|
||||||
|
"online_server_info": [
|
||||||
|
{
|
||||||
|
"abuse": "abuse@example.com",
|
||||||
|
"anti_ddos": false,
|
||||||
|
"bmc": {
|
||||||
|
"session_key": null
|
||||||
|
},
|
||||||
|
"boot_mode": "normal",
|
||||||
|
"contacts": {
|
||||||
|
"owner": "foobar",
|
||||||
|
"tech": "foobar"
|
||||||
|
},
|
||||||
|
"disks": [
|
||||||
|
{
|
||||||
|
"$ref": "/api/v1/server/hardware/disk/68452"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"$ref": "/api/v1/server/hardware/disk/68453"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"drive_arrays": [
|
||||||
|
{
|
||||||
|
"disks": [
|
||||||
|
{
|
||||||
|
"$ref": "/api/v1/server/hardware/disk/68452"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"$ref": "/api/v1/server/hardware/disk/68453"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"raid_controller": {
|
||||||
|
"$ref": "/api/v1/server/hardware/raidController/9910"
|
||||||
|
},
|
||||||
|
"raid_level": "RAID1"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"hardware_watch": true,
|
||||||
|
"hostname": "sd-42",
|
||||||
|
"id": 42,
|
||||||
|
"ip": [
|
||||||
|
{
|
||||||
|
"address": "195.154.172.149",
|
||||||
|
"mac": "28:92:4a:33:5e:c6",
|
||||||
|
"reverse": "195-154-172-149.rev.poneytelecom.eu.",
|
||||||
|
"switch_port_state": "up",
|
||||||
|
"type": "public"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"address": "10.90.53.212",
|
||||||
|
"mac": "28:92:4a:33:5e:c7",
|
||||||
|
"reverse": null,
|
||||||
|
"switch_port_state": "up",
|
||||||
|
"type": "private"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"last_reboot": "2018-08-23T08:32:03.000Z",
|
||||||
|
"location": {
|
||||||
|
"block": "A",
|
||||||
|
"datacenter": "DC3",
|
||||||
|
"position": 19,
|
||||||
|
"rack": "A23",
|
||||||
|
"room": "4 4-4"
|
||||||
|
},
|
||||||
|
"network": {
|
||||||
|
"ip": [
|
||||||
|
"195.154.172.149"
|
||||||
|
],
|
||||||
|
"ipfo": [],
|
||||||
|
"private": [
|
||||||
|
"10.90.53.212"
|
||||||
|
]
|
||||||
|
},
|
||||||
|
"offer": "Pro-1-S-SATA",
|
||||||
|
"os": {
|
||||||
|
"name": "FreeBSD",
|
||||||
|
"version": "11.1-RELEASE"
|
||||||
|
},
|
||||||
|
"power": "ON",
|
||||||
|
"proactive_monitoring": false,
|
||||||
|
"raid_controllers": [
|
||||||
|
{
|
||||||
|
"$ref": "/api/v1/server/hardware/raidController/9910"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"support": "Basic service level"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
'''
|
||||||
|
|
||||||
|
from ansible.module_utils.basic import AnsibleModule
|
||||||
|
from ansible.module_utils.online import (
|
||||||
|
Online, OnlineException, online_argument_spec
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
class OnlineServerInfo(Online):
|
||||||
|
|
||||||
|
def __init__(self, module):
|
||||||
|
super(OnlineServerInfo, self).__init__(module)
|
||||||
|
self.name = 'api/v1/server'
|
||||||
|
|
||||||
|
def _get_server_detail(self, server_path):
|
||||||
|
try:
|
||||||
|
return self.get(path=server_path).json
|
||||||
|
except OnlineException as exc:
|
||||||
|
self.module.fail_json(msg="A problem occurred while fetching: %s (%s)" % (server_path, exc))
|
||||||
|
|
||||||
|
def all_detailed_servers(self):
|
||||||
|
servers_api_path = self.get_resources()
|
||||||
|
|
||||||
|
server_data = (
|
||||||
|
self._get_server_detail(server_api_path)
|
||||||
|
for server_api_path in servers_api_path
|
||||||
|
)
|
||||||
|
|
||||||
|
return [s for s in server_data if s is not None]
|
||||||
|
|
||||||
|
|
||||||
|
def main():
|
||||||
|
module = AnsibleModule(
|
||||||
|
argument_spec=online_argument_spec(),
|
||||||
|
supports_check_mode=True,
|
||||||
|
)
|
||||||
|
|
||||||
|
try:
|
||||||
|
servers_info = OnlineServerInfo(module).all_detailed_servers()
|
||||||
|
module.exit_json(
|
||||||
|
online_server_info=servers_info
|
||||||
|
)
|
||||||
|
except OnlineException as exc:
|
||||||
|
module.fail_json(msg=exc.message)
|
||||||
|
|
||||||
|
|
||||||
|
if __name__ == '__main__':
|
||||||
|
main()
|
79
lib/ansible/modules/cloud/online/online_user_info.py
Normal file
79
lib/ansible/modules/cloud/online/online_user_info.py
Normal file
|
@ -0,0 +1,79 @@
|
||||||
|
#!/usr/bin/python
|
||||||
|
# -*- coding: utf-8 -*-
|
||||||
|
#
|
||||||
|
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
|
||||||
|
|
||||||
|
from __future__ import (absolute_import, division, print_function)
|
||||||
|
__metaclass__ = type
|
||||||
|
|
||||||
|
ANSIBLE_METADATA = {'metadata_version': '1.1',
|
||||||
|
'status': ['preview'],
|
||||||
|
'supported_by': 'community'}
|
||||||
|
|
||||||
|
DOCUMENTATION = r'''
|
||||||
|
---
|
||||||
|
module: online_user_info
|
||||||
|
short_description: Gather information about Online user.
|
||||||
|
description:
|
||||||
|
- Gather information about the user.
|
||||||
|
version_added: "2.9"
|
||||||
|
author:
|
||||||
|
- "Remy Leone (@sieben)"
|
||||||
|
extends_documentation_fragment: online
|
||||||
|
'''
|
||||||
|
|
||||||
|
EXAMPLES = r'''
|
||||||
|
- name: Gather Online user info
|
||||||
|
online_user_info:
|
||||||
|
register: result
|
||||||
|
|
||||||
|
- debug:
|
||||||
|
msg: "{{ result.online_user_info }}"
|
||||||
|
'''
|
||||||
|
|
||||||
|
RETURN = r'''
|
||||||
|
---
|
||||||
|
online_user_info:
|
||||||
|
description: Response from Online API
|
||||||
|
returned: success
|
||||||
|
type: complex
|
||||||
|
contains:
|
||||||
|
"online_user_info": {
|
||||||
|
"company": "foobar LLC",
|
||||||
|
"email": "foobar@example.com",
|
||||||
|
"first_name": "foo",
|
||||||
|
"id": 42,
|
||||||
|
"last_name": "bar",
|
||||||
|
"login": "foobar"
|
||||||
|
}
|
||||||
|
'''
|
||||||
|
|
||||||
|
from ansible.module_utils.basic import AnsibleModule
|
||||||
|
from ansible.module_utils.online import (
|
||||||
|
Online, OnlineException, online_argument_spec
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
class OnlineUserInfo(Online):
|
||||||
|
|
||||||
|
def __init__(self, module):
|
||||||
|
super(OnlineUserInfo, self).__init__(module)
|
||||||
|
self.name = 'api/v1/user'
|
||||||
|
|
||||||
|
|
||||||
|
def main():
|
||||||
|
module = AnsibleModule(
|
||||||
|
argument_spec=online_argument_spec(),
|
||||||
|
supports_check_mode=True,
|
||||||
|
)
|
||||||
|
|
||||||
|
try:
|
||||||
|
module.exit_json(
|
||||||
|
online_user_info=OnlineUserInfo(module).get_resources()
|
||||||
|
)
|
||||||
|
except OnlineException as exc:
|
||||||
|
module.fail_json(msg=exc.message)
|
||||||
|
|
||||||
|
|
||||||
|
if __name__ == '__main__':
|
||||||
|
main()
|
|
@ -4,5 +4,5 @@
|
||||||
connection: local
|
connection: local
|
||||||
|
|
||||||
roles:
|
roles:
|
||||||
- { role: online_server_facts, tags: test_online_server_facts }
|
- { role: online_server_info, tags: test_online_server_info }
|
||||||
- { role: online_user_facts, tags: test_online_user_facts }
|
- { role: online_user_info, tags: test_online_user_info }
|
||||||
|
|
|
@ -1,14 +1,14 @@
|
||||||
# ONLINE_TOKEN='XXX' ansible-playbook ./test/legacy/online.yml --tags test_online_server_facts
|
# ONLINE_TOKEN='XXX' ansible-playbook ./test/legacy/online.yml --tags test_online_server_info
|
||||||
|
|
||||||
- name: Get server information and register it in a variable
|
- name: Get server information and register it in a variable
|
||||||
online_server_facts:
|
online_server_info:
|
||||||
register: servers_facts
|
register: servers_info
|
||||||
|
|
||||||
- name: Display server variable
|
- name: Display server variable
|
||||||
debug:
|
debug:
|
||||||
var: servers_facts
|
var: servers_info
|
||||||
|
|
||||||
- name: Ensure retrieval of servers facts is success
|
- name: Ensure retrieval of servers info is success
|
||||||
assert:
|
assert:
|
||||||
that:
|
that:
|
||||||
- servers_facts is success
|
- servers_info is success
|
|
@ -1,14 +1,14 @@
|
||||||
# ONLINE_TOKEN='XXX' ansible-playbook ./test/legacy/online.yml --tags test_online_user_facts
|
# ONLINE_TOKEN='XXX' ansible-playbook ./test/legacy/online.yml --tags test_online_user_info
|
||||||
|
|
||||||
- name: Get user information and register it in a variable
|
- name: Get user information and register it in a variable
|
||||||
online_user_facts:
|
online_user_info:
|
||||||
register: user
|
register: user
|
||||||
|
|
||||||
- name: Display user variable
|
- name: Display user variable
|
||||||
debug:
|
debug:
|
||||||
var: user
|
var: user
|
||||||
|
|
||||||
- name: Ensure retrieval of user facts is success
|
- name: Ensure retrieval of user info is success
|
||||||
assert:
|
assert:
|
||||||
that:
|
that:
|
||||||
- user is success
|
- user is success
|
Loading…
Reference in a new issue