VhJ=ddlmZmZmZeZdZdZdZddl Z ddl m Z m Z ddl mZddlmZdd lmZmZdd lmZdd lmZd Zd ZdZdZdZdZdZdZGddeZ dZ!dZ"e#dk(re!yy))absolute_importdivisionprint_functiona --- module: ome_session short_description: Manage OpenManage Enterprise and OpenManage Enterprise modular sessions version_added: "9.3.0" description: - This module allows you to create and delete sessions on OpenManage Enterprise and OpenManage Enterprise Modular. options: hostname: description: - IP address or hostname of the OpenManage Enterprise. type: str username: description: - Username of the OpenManage Enterprise. If the username is not provided, then the environment variable E(OME_USERNAME) is used. - I(username) is required when I(state) is C(present). type: str password: description: - Password of the OpenManage Enterprise. If the password is not provided, then the environment variable E(OME_PASSWORD) is used. - I(password) is required when I(state) is C(present). type: str port: description: - Port of the OpenManage Enterprise. type: int default: 443 validate_certs: description: - If C(false), the SSL certificates will not be validated. - Configure C(false) only on personally controlled sites where self-signed certificates are used. type: bool default: true ca_path: description: - The Privacy Enhanced Mail (PEM) file that contains a CA certificate to be used for the validation. type: path timeout: description: - The HTTPS socket level timeout in seconds. type: int default: 30 state: description: - The state of the session in OpenManage Enterprise. - C(present) creates a session. - C(absent) deletes a session. - Module will always report changes found to be applied when I(state) is C(present). choices: [present, absent] type: str default: present x_auth_token: description: - Authentication token. - I(x_auth_token) is required when I(state) is C(absent). type: str aliases: ['auth_token'] session_id: description: - Session ID of the OpenManage Enterprise. - I(session_id) is required when I(state) is C(absent). type: str requirements: - "python >= 3.9.6" author: - "Kritika Bhateja (@Kritika-Bhateja-03)" notes: - Run this module from a system that has direct access to Dell OpenManage Enterprise. - This module supports IPv4 and IPv6 addresses. - This module supports C(check_mode). - This module will always report changes found to be applied when I(state) is C(present). a --- - name: Create a session dellemc.openmanage.ome_session: hostname: 198.162.0.1 username: username password: password ca_path: "/path/to/ca_cert.pem" state: present - name: Delete a session dellemc.openmanage.ome_session: hostname: 198.162.0.1 ca_path: "/path/to/ca_cert.pem" state: absent x_auth_token: aed4aa802b748d2f3b31deec00a6b28a session_id: 4b48e9ab-809e-4087-b7c4-201a16e0143d - name: Create a session and execute other modules block: - name: Create a session dellemc.openmanage.ome_session: hostname: 198.162.0.1 username: username password: password ca_path: "/path/to/ca_cert.pem" state: present register: authData - name: Call ome_user_info module dellemc.openmanage.ome_user_info: hostname: 198.162.0.1 ca_path: "/path/to/ca_cert.pem" x_auth_token: "{{ authData.x_auth_token }}" - name: Call ome_network_vlan_info module dellemc.openmanage.ome_network_vlan_info: hostname: 198.162.0.1 ca_path: "/path/to/ca_cert.pem" x_auth_token: "{{ authData.x_auth_token }}" always: - name: Destroy a session dellemc.openmanage.ome_session: hostname: 198.162.0.1 ca_path: "/path/to/ca_cert.pem" state: absent x_auth_token: "{{ authData.x_auth_token }}" session_id: "{{ authData.session_data.Id }}" a  --- msg: description: Status of the session operation. returned: always type: str sample: "The session has been created successfully." session_data: description: The session details. returned: For session creation operation type: dict sample: { "Id": "d5c28d8e-1084-4055-9c01-e1051cfee2dd", "Description": "admin", "Name": "API", "UserName": "admin", "UserId": 10078, "Password": null, "Roles": [ "BACKUP_ADMINISTRATOR" ], "IpAddress": "100.198.162.0", "StartTimeStamp": "2023-07-03 07:22:43.683", "LastAccessedTimeStamp": "2023-07-03 07:22:43.683", "DirectoryGroup": [] } x_auth_token: description: Authentication token. returned: For session creation operation type: str sample: "d15f17f01cd627c30173b1582642497d" error_info: description: Details of the HTTP Error. returned: On HTTP error type: dict sample: { "error": { "@Message.ExtendedInfo": [ { "Message": "Unable to complete the operation because an invalid username and/or password is entered, and therefore authentication failed.", "MessageArgs": [], "MessageArgs@odata.count": 0, "MessageId": "IDRAC.2.7.SYS415", "RelatedProperties": [], "RelatedProperties@odata.count": 0, "Resolution": "Enter valid user name and password and retry the operation.", "Severity": "Warning" } ], "code": "Base.1.12.GeneralError", "message": "A general error has occurred. See ExtendedInfo for more information" } } N) HTTPErrorURLError)Session) AnsibleModule)ConnectionErrorSSLValidationError env_fallback) remove_keyz/api/SessionService/Sessions @odata.idz (.*?)@odataz*The session has been created successfully.z*The session has been deleted successfully.z"Unable to '{operation}' a session.zChanges found to be applied.zNo changes found to be applied.c0eZdZfdZdZdZdZxZS) OMESessionct||d|jjj d|jjj dd|_y)NTusernamepassword)force_basic_auth url_username url_password)super__init__moduleparamsget url_kwrags)selfr __class__s r/home/dcms/DCMS/lib/python3.12/site-packages/ansible_collections/dellemc/openmanage/plugins/modules/ome_session.pyrzOMESession.__init__sM  /3+/;;+=+=+A+A*+M+/;;+=+=+A+A*+MOc|jjtd}|j}|dDcgc]}|dj dd}}|v}|Scc}w)ae Retrieves the status of a session given its URL and ID. Args: session_url (str): The URL of the session. session_id (str): The ID of the session. Returns: int: The status code of the session status response. If an HTTPError occurs, the status code of the error is returned. GETvaluer')instanceinvoke_request SESSION_URL json_datasplit)r session_url session_idsession_status_response sessions_data session_idssession_statuss r get_session_statuszOMESession.get_session_statussj#'--">">{E"R/99 O\]dOefz+.44S9!<f f#{2gsAc|jjjd|jjjdd}|jjr!|jj t d|j jtd||j}|j}|dk(r\|j}t|t }|jjd }|jj td|| y|jj t j#d dy)a5 Executes the session creation process. This function creates a session by sending a POST request to the session URL with the provided username and password. If the request is successful (status code 201), it retrieves the session details, removes any OData keys from the response, and extracts the X-Auth-Token from the response headers. It then exits the module with a success message, indicating that the session was created successfully, and provides the session data and X-Auth-Token as output variables. If the request fails (status code other than 201), it exits the module with a failure message, indicating that the session creation failed. Parameters: None Returns: None rr)UserNamePasswordTmsgchangedPOST)data url_kwargs regex_patternz X-Auth-Token)r7r8 session_data x_auth_tokencreate operationr7failedN)rrr check_mode exit_jsonCHANGES_FOUND_MSGr'r(r)r status_coder*r ODATA_REGEXheadersCREATE_SUCCESS_MSG FAILURE_MSGformat)rpayloadsession_responsestatussession_detailsr?r@s r create_sessionzOMESession.create_sessions, ${{1155jA#{{1155jAC ;; ! ! KK ! !&7 ! F==77 VRYfjfufu7v!-- S=.88O%o[QL+3377GL KK ! !&8*./;/; " = KK ! !k&8&88&8&LUY ! Zr!c |jjjd}|jt|}|jj rE|r"|jj tdy |jj ty |r` tdz|zdz}|jj|d}|j}|dk(r"|jj tdy y |jj ty #t$r`}ttj |t" }|jj t$j'd |d Yd }~y d }~wwxYw)a Executes the deletion of a session. This function retrieves the session ID from the module parameters.It then invokes a DELETE request to the session URL with the session ID appended. The response from the request is stored in the `session_response` variable. If the response status code is 200, indicating a successful deletion, the function exits the module with a success message and sets the `changed` parameter to True. Otherwise, it exits the module with a failure message and sets the `failed` parameter to True. Parameters: None Returns: None r-Tr6)r7z('z')DELETEr=deleterBr7 error_inforEN)rrrr2r)rFrGrHNO_CHANGES_FOUND_MSGr'r(rIDELETE_SUCCESS_MSGrrjsonloadrJrMrN)rr-r1delete_session_urlrPrQerr filter_errs r delete_sessionzOMESession.delete_sessionsC"[[''++L9 00jI ;; ! ! %%*;T%J %%*>%? 7)4t);j)H4)O&'+}}'C'CDVX`'a$-99F} --2Dd-S% %%*>%? !7!+DIIcN+!VJKK))k.@.@8.@.T5?15*777sAD F#AE>>F)__name__ __module__ __qualname__rr2rSra __classcell__)rs@r rrsO $%[N&@r!rct}t|gdgdgd} t|}|jj d}|dk(r|j y |j y #t$r]}i}t|tr$ttj|t}|jt||dYd }~y d }~wt $r&}|jt|d Yd }~y d }~wt"t$t&t(t*f$r&}|jt|d Yd }~y d }~wwxYw) a Main function that initializes the Ansible module with the argument specs and required if conditions. It then creates a SessionAPI object with the module parameters and performs a session operation based on the state parameter. If the state is "present", it creates a CreateSession object and executes it. If the state is "absent", it creates a DeleteSession object and executes it. The session status is returned. Raises: HTTPError: If an HTTP error occurs, the error message and filtered error information are returned in the module's exit_json. URLError: If a URL error occurs, the error message is returned in the module's exit_json. SSLValidationError, ConnectionError, TypeError, ValueError, OSError: If any other error occurs, the error message is returned in the module's exit_json. Returns: None )statepresent)rr)rgabsent)r@r-T) argument_spec required_ifsupports_check_modergrhr=rXN)r7 unreachablerD)get_argument_specr rrrrSrar isinstancedictrr\r]rJrGstrrr r TypeError ValueErrorOSError)specsromesession_operationr_r`s r mainrxBs(  E  ; @ ! F4 "MM--g6  )       K c4 #DIIcN+NJSX*TJJ 9SX488 J P4SXd334s6;A-A-- E6AC EC;;!ED==Ec |ddidtdgfdddtdgfddd d d dd d d d ddd ddddgddddgdddid S)a Returns a dictionary representing the argument specification for a module. The dictionary contains the following keys and their corresponding values: - "hostname": A string representing the hostname. - "username": A string representing the username. It has a fallback option to retrieve the value from the environment variable 'IDRAC_USERNAME'. - "password": A string representing the password. It is marked as not to be logged and has a fallback option to retrieve the value from the environment variable 'IDRAC_PASSWORD'. - "port": An integer representing the port number. The default value is 443. - "validate_certs": A boolean representing whether to validate certificates. The default value is True. - "ca_path": A path representing the certificate authority path. The default value is None. - "timeout": An integer representing the timeout value. The default value is 30. - "state": A string representing the state. The default value is "present". The choices are ["present", "absent"]. - "x_auth_token": A string representing the authentication token. It is marked as not to be logged. - "session_id": A string representing the session ID. Returns: A dictionary representing the argument specification. typerq OME_USERNAME)rzfallbackT OME_PASSWORD)rzno_logr|inti)rzdefaultboolpathNrhri)rzrchoices auth_token)rzr~aliases) hostnamerrportvalidate_certsca_pathtimeoutrgr@r-r r!r rnrnqsz2UO"?O0PQ"dP^O_@`a3/#)d;"t4!b1I9hBWX!&$L>Ruo  r!__main__)$ __future__rrrrz __metaclass__ DOCUMENTATIONEXAMPLESRETURNr\ urllib.errorrrIansible_collections.dellemc.openmanage.plugins.module_utils.session_utilsransible.module_utils.basicr ansible.module_utils.urlsr r &ansible.module_utils.common.parametersr Aansible_collections.dellemc.openmanage.plugins.module_utils.utilsrr)ODATArJrLr[rMrHrZrrxrnrbrr!r rsCB I V0 d5 p ,]4I?X,  AA2 28f@f@R,4^#L zFr!