|
| 1 | +.. _ome_server_interface_profile_info_module: |
| 2 | + |
| 3 | + |
| 4 | +ome_server_interface_profile_info -- Retrieves the information of server interface profile on OpenManage Enterprise Modular. |
| 5 | +============================================================================================================================ |
| 6 | + |
| 7 | +.. contents:: |
| 8 | + :local: |
| 9 | + :depth: 1 |
| 10 | + |
| 11 | + |
| 12 | +Synopsis |
| 13 | +-------- |
| 14 | + |
| 15 | +This module allows to retrieves the information of server interface profile on OpenManage Enterprise Modular. |
| 16 | + |
| 17 | + |
| 18 | + |
| 19 | +Requirements |
| 20 | +------------ |
| 21 | +The below requirements are needed on the host that executes this module. |
| 22 | + |
| 23 | +- python >= 3.8.6 |
| 24 | + |
| 25 | + |
| 26 | + |
| 27 | +Parameters |
| 28 | +---------- |
| 29 | + |
| 30 | + device_id (optional, list, None) |
| 31 | + The ID of the device. |
| 32 | + |
| 33 | + *device_id* is mutually exclusive with *device_service_tag*. |
| 34 | + |
| 35 | + |
| 36 | + device_service_tag (optional, list, None) |
| 37 | + The service tag of the device. |
| 38 | + |
| 39 | + *device_service_tag* is mutually exclusive with *device_id*. |
| 40 | + |
| 41 | + |
| 42 | + hostname (True, str, None) |
| 43 | + OpenManage Enterprise Modular IP address or hostname. |
| 44 | + |
| 45 | + |
| 46 | + username (True, str, None) |
| 47 | + OpenManage Enterprise Modular username. |
| 48 | + |
| 49 | + |
| 50 | + password (True, str, None) |
| 51 | + OpenManage Enterprise Modular password. |
| 52 | + |
| 53 | + |
| 54 | + port (optional, int, 443) |
| 55 | + OpenManage Enterprise Modular HTTPS port. |
| 56 | + |
| 57 | + |
| 58 | + validate_certs (optional, bool, True) |
| 59 | + If ``False``, the SSL certificates will not be validated. |
| 60 | + |
| 61 | + Configure ``False`` only on personally controlled sites where self-signed certificates are used. |
| 62 | + |
| 63 | + Prior to collection version ``5.0.0``, the *validate_certs* is ``False`` by default. |
| 64 | + |
| 65 | + |
| 66 | + ca_path (optional, path, None) |
| 67 | + The Privacy Enhanced Mail (PEM) file that contains a CA certificate to be used for the validation. |
| 68 | + |
| 69 | + |
| 70 | + timeout (optional, int, 30) |
| 71 | + The socket level timeout in seconds. |
| 72 | + |
| 73 | + |
| 74 | + |
| 75 | + |
| 76 | + |
| 77 | +Notes |
| 78 | +----- |
| 79 | + |
| 80 | +.. note:: |
| 81 | + - Run this module from a system that has direct access to OpenManage Enterprise Modular. |
| 82 | + - This module supports ``check_mode``. |
| 83 | + |
| 84 | + |
| 85 | + |
| 86 | + |
| 87 | +Examples |
| 88 | +-------- |
| 89 | + |
| 90 | +.. code-block:: yaml+jinja |
| 91 | + |
| 92 | + |
| 93 | + --- |
| 94 | + - name: Retrieves the server interface profiles of all the device using device ID. |
| 95 | + dellemc.openmanage.ome_server_interface_profile_info: |
| 96 | + hostname: "192.168.0.1" |
| 97 | + username: "username" |
| 98 | + password: "password" |
| 99 | + ca_path: "/path/to/ca_cert.pem" |
| 100 | + device_id: |
| 101 | + - 10001 |
| 102 | + - 10002 |
| 103 | + |
| 104 | + - name: Retrieves the server interface profiles of all the device using device service tag. |
| 105 | + dellemc.openmanage.ome_server_interface_profile_info: |
| 106 | + hostname: "192.168.0.1" |
| 107 | + username: "username" |
| 108 | + password: "password" |
| 109 | + ca_path: "/path/to/ca_cert.pem" |
| 110 | + device_service_tag: |
| 111 | + - 6GHH6H2 |
| 112 | + - 6KHH6H3 |
| 113 | + |
| 114 | + |
| 115 | + |
| 116 | +Return Values |
| 117 | +------------- |
| 118 | + |
| 119 | +msg (on success, str, Successfully retrieved the server interface profile information.) |
| 120 | + Overall status of the server interface profile information. |
| 121 | + |
| 122 | + |
| 123 | +server_profiles (success, list, [AnsibleMapping([('BondingTechnology', 'LACP'), ('Id', '6KZK6K2'), ('ServerInterfaceProfile', [AnsibleMapping([('FabricId', '1ea6bf64-3cf0-4e06-a136-5046d874d1e7'), ('Id', 'NIC.Mezzanine.1A-1-1'), ('NativeVLAN', 0), ('Networks', [AnsibleMapping([('CreatedBy', 'system'), ('CreationTime', '2018-11-27 10:22:14.140'), ('Description', 'VLAN 1'), ('Id', 10001), ('InternalRefNWUUId', 'add035b9-a971-400d-a3fa-bb365df1d476'), ('Name"', 'VLAN 1'), ('Type', 2), ('UpdatedBy', None), ('UpdatedTime', '2018-11-27 10:22:14.140'), ('VlanMaximum', 1), ('VlanMinimum', 1)])]), ('NicBonded', True), ('OnboardedPort', '59HW8X2:ethernet1/1/1')]), AnsibleMapping([('FabricId', '3ea6be04-5cf0-4e05-a136-5046d874d1e6'), ('Id', 'NIC.Mezzanine.1A-2-1'), ('NativeVLAN', 0), ('Networks', [AnsibleMapping([('CreatedBy', 'system'), ('CreationTime', '2018-09-25 14:46:12.374'), ('Description', None), ('Id', 10155), ('InternalRefNWUUId', 'f15a36b6-e3d3-46b2-9e7d-bf9cd66e180d'), ('Name', 'jagvlan'), ('Type', 1), ('UpdatedBy', None), ('UpdatedTime', '2018-09-25 14:46:12.374'), ('VlanMaximum', 143), ('VlanMinimum', 143)])]), ('NicBonded', False), ('OnboardedPort', '6H7J6Z2:ethernet1/1/1')])])])]) |
| 124 | + Returns the information of collected server interface profile information. |
| 125 | + |
| 126 | + |
| 127 | +error_info (on HTTP error, dict, AnsibleMapping([('error', AnsibleMapping([('code', 'Base.1.0.GeneralError'), ('message', 'A general error has occurred. See ExtendedInfo for more information.'), ('@Message.ExtendedInfo', [AnsibleMapping([('MessageId', 'GEN1234'), ('RelatedProperties', []), ('Message', 'Unable to process the request because an error occurred.'), ('MessageArgs', []), ('Severity', 'Critical'), ('Resolution', 'Retry the operation. If the issue persists, contact your system administrator.')])])]))])) |
| 128 | + Details of the HTTP Error. |
| 129 | + |
| 130 | + |
| 131 | + |
| 132 | + |
| 133 | + |
| 134 | +Status |
| 135 | +------ |
| 136 | + |
| 137 | + |
| 138 | + |
| 139 | + |
| 140 | + |
| 141 | +Authors |
| 142 | +~~~~~~~ |
| 143 | + |
| 144 | +- Felix Stephen (@felixs88) |
| 145 | + |
0 commit comments