VhdZddlmZmZmZeZdZdZdZ ddl m Z ddl m Z e jdZGd d eZd Zd Zd Zedk(reyy)zI Ansible module for managing device on Dell Technologies (Dell) PowerFlex)absolute_importdivisionprint_functionao module: device version_added: '1.1.0' short_description: Manage device on Dell PowerFlex description: - Managing device on PowerFlex storage system includes adding new device, getting details of device, and removing a device. author: - Rajshree Khare (@khareRajshree) extends_documentation_fragment: - dellemc.powerflex.powerflex options: current_pathname: description: - Full path of the device to be added. - Required while adding a device. type: str device_name: description: - Device name. - Mutually exclusive with I(device_id). type: str device_id: description: - Device ID. - Mutually exclusive with I(device_name). type: str sds_name: description: - The name of the SDS. - Required while adding a device. - Mutually exclusive with I(sds_id). type: str sds_id: description: - The ID of the SDS. - Required while adding a device. - Mutually exclusive with I(sds_name). type: str storage_pool_name: description: - Storage Pool name. - Used while adding a storage device. - Mutually exclusive with I(storage_pool_id), I(acceleration_pool_id) and I(acceleration_pool_name). type: str storage_pool_id: description: - Storage Pool ID. - Used while adding a storage device. - Media type supported are C(SSD) and C(HDD). - Mutually exclusive with I(storage_pool_name), I(acceleration_pool_id) and I(acceleration_pool_name). type: str acceleration_pool_name: description: - Acceleration Pool Name. - Used while adding an acceleration device. - Media type supported are C(SSD) and C(NVDIMM). - Mutually exclusive with I(storage_pool_id), I(storage_pool_name) and I(acceleration_pool_name). type: str acceleration_pool_id: description: - Acceleration Pool ID. - Used while adding an acceleration device. - Media type supported are C(SSD) and C(NVDIMM). - Mutually exclusive with I(acceleration_pool_name), I(storage_pool_name) and I(storage_pool_id). type: str protection_domain_name: description: - Protection domain name. - Used while identifying a storage pool along with I(storage_pool_name). - Mutually exclusive with I(protection_domain_id). type: str protection_domain_id: description: - Protection domain ID. - Used while identifying a storage pool along with I(storage_pool_name). - Mutually exclusive with I(protection_domain_name). type: str external_acceleration_type: description: - Device external acceleration types. - Used while adding a device. type: str choices: ['Invalid', 'None', 'Read', 'Write', 'ReadAndWrite'] media_type: description: - Device media types. - Required while adding a device. type: str choices: ['HDD', 'SSD', 'NVDIMM'] state: description: - State of the device. choices: ['present', 'absent'] required: true type: str force: description: - Using the Force flag to add a device. - Use this flag, to overwrite existing data on the device. - Use this flag with caution, because all data on the device will be destroyed. type: bool default: false notes: - The value for device_id is generated only after successful addition of the device. - To uniquely identify a device, either I(device_id) can be passed or one of I(current_pathname) or I(device_name) must be passed with I(sds_id) or I(sds_name). - It is recommended to install Rfcache driver for SSD device on SDS in order to add it to an acceleration pool. - The I(check_mode) is not supported. ac - name: Add a device dellemc.powerflex.device: hostname: "{{hostname}}" username: "{{username}}" password: "{{password}}" validate_certs: "{{validate_certs}}" port: "{{port}}" current_pathname: "/dev/sdb" sds_name: "node1" media_type: "HDD" device_name: "device2" storage_pool_name: "pool1" protection_domain_name: "domain1" external_acceleration_type: "ReadAndWrite" state: "present" - name: Add a device with force flag dellemc.powerflex.device: hostname: "{{hostname}}" username: "{{username}}" password: "{{password}}" validate_certs: "{{validate_certs}}" port: "{{port}}" current_pathname: "/dev/sdb" sds_name: "node1" media_type: "HDD" device_name: "device2" storage_pool_name: "pool1" protection_domain_name: "domain1" external_acceleration_type: "ReadAndWrite" force: true state: "present" - name: Get device details using device_id dellemc.powerflex.device: hostname: "{{hostname}}" username: "{{username}}" password: "{{password}}" validate_certs: "{{validate_certs}}" port: "{{port}}" device_id: "d7fe088900000000" state: "present" - name: Get device details using (current_pathname, sds_name) dellemc.powerflex.device: hostname: "{{hostname}}" username: "{{username}}" password: "{{password}}" validate_certs: "{{validate_certs}}" port: "{{port}}" current_pathname: "/dev/sdb" sds_name: "node0" state: "present" - name: Get device details using (current_pathname, sds_id) dellemc.powerflex.device: hostname: "{{hostname}}" username: "{{username}}" password: "{{password}}" validate_certs: "{{validate_certs}}" port: "{{port}}" current_pathname: "/dev/sdb" sds_id: "5717d71800000000" state: "present" - name: Remove a device using device_id dellemc.powerflex.device: hostname: "{{hostname}}" username: "{{username}}" password: "{{password}}" validate_certs: "{{validate_certs}}" port: "{{port}}" device_id: "76eb7e2f00010000" state: "absent" - name: Remove a device using (current_pathname, sds_id) dellemc.powerflex.device: hostname: "{{hostname}}" username: "{{username}}" password: "{{password}}" validate_certs: "{{validate_certs}}" port: "{{port}}" current_pathname: "/dev/sdb" sds_name: "node1" state: "absent" a changed: description: Whether or not the resource has changed. returned: always type: bool sample: 'false' device_details: description: Details of the device. returned: When device exists type: dict contains: accelerationPoolId: description: Acceleration pool ID. type: str accelerationPoolName: description: Acceleration pool name. type: str accelerationProps: description: Indicates acceleration props. type: str aggregatedState: description: Indicates aggregated state. type: str ataSecurityActive: description: Indicates ATA security active state. type: bool autoDetectMediaType: description: Indicates auto detection of media type. type: str cacheLookAheadActive: description: Indicates cache look ahead active state. type: bool capacity: description: Device capacity. type: int capacityLimitInKb: description: Device capacity limit in KB. type: int deviceCurrentPathName: description: Device current path name. type: str deviceOriginalPathName: description: Device original path name. type: str deviceState: description: Indicates device state. type: str deviceType: description: Indicates device type. type: str errorState: description: Indicates error state. type: str externalAccelerationType: description: Indicates external acceleration type. type: str fglNvdimmMetadataAmortizationX100: description: Indicates FGL NVDIMM meta data amortization value. type: int fglNvdimmWriteCacheSize: description: Indicates FGL NVDIMM write cache size. type: int firmwareVersion: description: Indicates firmware version. type: str id: description: Device ID. type: str ledSetting: description: Indicates LED setting. type: str links: description: Device links. type: list contains: href: description: Device instance URL. type: str rel: description: Relationship of device with different entities. type: str logicalSectorSizeInBytes: description: Logical sector size in bytes. type: int longSuccessfulIos: description: Indicates long successful IOs. type: list maxCapacityInKb: description: Maximum device capacity limit in KB. type: int mediaFailing: description: Indicates media failing. type: bool mediaType: description: Indicates media type. type: str modelName: description: Indicates model name. type: str name: description: Device name. type: str persistentChecksumState: description: Indicates persistent checksum state. type: str physicalSectorSizeInBytes: description: Physical sector size in bytes. type: int protectionDomainId: description: Protection domain ID. type: str protectionDomainName: description: Protection domain name. type: str raidControllerSerialNumber: description: RAID controller serial number. type: str rfcacheErrorDeviceDoesNotExist: description: Indicates RF cache error device does not exist. type: bool rfcacheProps: description: RF cache props. type: str sdsId: description: SDS ID. type: str sdsName: description: SDS name. type: str serialNumber: description: Indicates Serial number. type: str spSdsId: description: Indicates SPs SDS ID. type: str ssdEndOfLifeState: description: Indicates SSD end of life state. type: str storagePoolId: description: Storage Pool ID. type: str storagePoolName: description: Storage Pool name. type: str storageProps: description: Storage props. type: list temperatureState: description: Indicates temperature state. type: str vendorName: description: Indicates vendor name. type: str writeCacheActive: description: Indicates write cache active. type: bool sample: { "accelerationPoolId": null, "accelerationProps": null, "aggregatedState": "NeverFailed", "ataSecurityActive": false, "autoDetectMediaType": "SSD", "cacheLookAheadActive": false, "capacity": 0, "capacityLimitInKb": 365772800, "deviceCurrentPathName": "/dev/sdb", "deviceOriginalPathName": "/dev/sdb", "deviceState": "Normal", "deviceType": "Unknown", "errorState": "None", "externalAccelerationType": "None", "fglNvdimmMetadataAmortizationX100": 150, "fglNvdimmWriteCacheSize": 16, "firmwareVersion": null, "id": "b6efa59900000000", "ledSetting": "Off", "links": [ { "href": "/api/instances/Device::b6efa59900000000", "rel": "self" }, { "href": "/api/instances/Device::b6efa59900000000/relationships /Statistics", "rel": "/api/Device/relationship/Statistics" }, { "href": "/api/instances/Sds::8f3bb0ce00000000", "rel": "/api/parent/relationship/sdsId" }, { "href": "/api/instances/StoragePool::e0d8f6c900000000", "rel": "/api/parent/relationship/storagePoolId" }, { "href": "/api/instances/SpSds::fedf6f2000000000", "rel": "/api/parent/relationship/spSdsId" } ], "logicalSectorSizeInBytes": 0, "longSuccessfulIos": { "longWindow": null, "mediumWindow": null, "shortWindow": null }, "maxCapacityInKb": 365772800, "mediaFailing": false, "mediaType": "HDD", "modelName": null, "name": "device230", "persistentChecksumState": "Protected", "physicalSectorSizeInBytes": 0, "protectionDomainId": "9300c1f900000000", "protectionDomainName": "domain1", "raidControllerSerialNumber": null, "rfcacheErrorDeviceDoesNotExist": false, "rfcacheProps": null, "sdsId": "8f3bb0ce00000000", "sdsName": "node1", "serialNumber": null, "slotNumber": null, "spSdsId": "fedf6f2000000000", "ssdEndOfLifeState": "NeverFailed", "storagePoolId": "e0d8f6c900000000", "storagePoolName": "pool1", "storageProps": { "destFglAccDeviceId": null, "destFglNvdimmSizeMb": 0, "fglAccDeviceId": null, "fglNvdimmSizeMb": 0 }, "temperatureState": "NeverFailed", "vendorName": null, "writeCacheActive": false } ) AnsibleModule)utilsdeviceceZdZdZdZ ddZddZ ddZ ddZ ddZ d Z d Z dd Z d Z d ZdZdZ ddZdZdZdZdZdZdZdZdZy)PowerFlexDevicezClass with device operationsc ntj|_|jjt ddgddgddgddgd d gd dgd dgddgddgdd gg }t |jd | |_tj|j  tj|j j|_ tjdy#t$rM}tjt||j j!t|Yd}~yd}~wwxYw)z. Define all parameters required by this modulesds_namesds_id device_name device_idprotection_domain_nameprotection_domain_idstorage_pool_namestorage_pool_idacceleration_pool_nameacceleration_pool_idcurrent_pathnameF) argument_specsupports_check_modemutually_exclusivez3Got the PowerFlex system connection object instancemsgN)r%get_powerflex_gateway_host_parameters module_paramsupdateget_powerflex_device_parametersrmoduleensure_required_libs%get_powerflex_gateway_host_connectionparamspowerflex_connLOGinfo Exceptionerrorstr fail_json)self mut_ex_argses l/home/dcms/DCMS/lib/python3.12/site-packages/ansible_collections/dellemc/powerflex/plugins/modules/device.py__init__zPowerFlexDevice.__init__s)"HHJ !!"A"CD"H-%{30.0+->?02HI.0AB02EF#Z0#X.#%78 : $,, %*, ""4;;/ ."'"M"M ""#$D  HHJ K . IIc!f  KK ! !c!f ! - - .sAC D4'AD//D4Nc  |r,|r*|jjj||d}nV|r,|r*|jjj||d}n(|jjjd|i}t|dk(rd}tj |y|dS#t $rI}dt|z}tj||jj| Yd}~yd}~wwxYw) aGet device details :param current_pathname: Device path name :type current_pathname: str :param sds_id: ID of the SDS :type sds_id: str :param device_name: Name of the device :type device_name: str :param device_id: ID of the device :type device_id: str :return: Details of device if it exist :rtype: dict )deviceCurrentPathNamesdsId filter_fields)namer2idrzDevice not foundNz(Failed to get the device with error '%s'r) r$rgetlenr%r&r'r)r(r r*) r+rr rrdevice_detailsrr- error_msgs r.get_device_detailsz"PowerFlexDevice.get_device_detailss 1F!%!4!4!;!;!?!?"a'( !!$ $ 1BSVKI IIi KK ! !i ! 0 0 1sB)B1,B11 D:?C>>Dc|r|n|} d}|r(|jjjd|i}|r(|jjjd|i}|s6d|z}tj ||j j ||dS#t$rM}d|d t|d }tj ||j j |Yd}~yd}~wwxYw) zGet SDS details :param sds_name: Name of the SDS :param sds_id: ID of the SDS :return: SDS details :rtype: dict Nr6r3r5zCUnable to find the SDS with '%s'. Please enter a valid SDS name/id.rrzFailed to get the SDS '' with error '') r$sdsr7r%r(r r*r'r))r+r r name_or_id sds_detailsr:r-s r.get_sdszPowerFlexDevice.get_sdss &V8  1K"115599#'.:2 "115599#)8"4:6 9;EF  )$ %%)%4q> ! 1%s1v/I IIi KK ! !i ! 0 0  1BB C1$AC,,C1c|r|n|} d}|r(|jjjd|i}|r(|jjjd|i}|s6d|z}tj ||j j ||dS#t$rM}d|d t|d }tj ||j j |Yd}~yd}~wwxYw) zGet protection domain details :param protection_domain_name: Name of the protection domain :param protection_domain_id: ID of the protection domain :return: Protection domain details :rtype: dict Nr6r3r5z_Unable to find the protection domain with '%s'. Please enter a valid protection domain name/id.rrz%Failed to get the protection domain 'r=r>) r$protection_domainr7r%r(r r*r'r))r+rrr@ pd_detailsr:r-s r.get_protection_domainz%PowerFlexDevice.get_protection_domain5s.B)'  1J#!00BBFF#')=">G@ &!00BBFF#)+A"BGD ')34  )$ %%)%4a=  1(2CF) r$ storage_poolr7r%r(r r*r'r))r+rrrr@storage_pool_detailsr:r-s r.get_storage_poolz PowerFlexDevice.get_storage_poolXs)8_=N  1#' '+':':'G'G'K'K#'"9(L(;$!'+':':'G'G'K'K+<9M#O(L($ (')34  )$ %%)%4'* * 1(2CF) r$acceleration_poolr7r%r(r r*r'r))r+rrrr@acceleration_pool_detailsr:r-s r.get_acceleration_poolz%PowerFlexDevice.get_acceleration_pool~s$*)?  1(, %#,0,?,?%%cc294c'5*&,0,?,?%%cc 6.B9Dc'E* -')34  )$ %%)%4,Q/ / 1(2CF) r8stripr%r(r r*r&r$rcreater#r'r)) r+rrr rrWrrVr: add_paramsr-s r. add_devicezPowerFlexDevice.add_devices(6 1"c+*;*;*=&>!&C/  )$ %%)%4'3/?/E/E/G+HA+M+  )$ %%)%4~V\\^!4!93  )$ %%)%4&+?+G&  )$ %%)%4.v17'(, .J HH4j A    & & - -!14H+E%K /kk((1 . 3 1(3SV=I IIi KK ! !i ! 0 0  1sFF G5(AG00G5c0 tjd||jjj |y#t $rM}d|dt |d}tj||jj|Yd}~yd}~wwxYw) zRemove device :param device_id: Device ID :type device_id: str return: Boolean indicating if remove device operation is successful zDevice to be removed: %s)rTzRemove device 'z' operation failed with error 'r>rN) r%r&r$rdeleter'r)r(r r*)r+rr-r:s r. remove_devicezPowerFlexDevice.remove_devicesz 1 HH/ ;    & & - - - B 1(13q6;I IIi KK ! !i ! 0 0  1s3v||~+>!+CG  )$ %%)%4 ,D%?  $[->->-@)AQ)FEI IIi KK ! !i ! 0*G $rec|rr|t|jdk(rS|t|jdk(r4d}tj||jj |yyy|Qt|jdk(r4d}tj||jj |yyy)NrzXsds_name or sds_id is mandatory along with current_pathname. Please enter a valid value.rz0Please enter a valid value for current_pathname.rg)r+rr r r:s r.r`z)PowerFlexDevice.validate_current_pathnameOs  C(8$9Q$>3v||~+>!+CL  )$ %%)%4 ,D%?  )(..01Q6JI IIi KK ! !i ! 07*rec|r3d}tj||jj||r@|=|:|7|4d}tj ||jj|yyyyyy)z"Validate the add device parameterszFAddition of device is allowed using device_name only, device_id given.rNzeStorage Pool ID/name or Acceleration Pool ID/name is mandatory along with external_acceleration_type.)r%r&r r*r()r+rrVrrrrr:s r.validate_add_parametersz'PowerFlexDevice.validate_add_parameters]s =I HHY  KK ! !i ! 0 %/*A%-(0*26I IIi KK ! !i ! 0 31.+B %rec|jjd}|jjd}|jjd}|jjd}|jjd}|jjd}|jjd}|jjd}|jjd } |jjd } |jjd } |jjd } |jjd } |jjd}tdi}|j||||||r|j |}|j ||||}|r|d}dt |z}tj|d}|dk(rV|rt|| | }|j|n|j|||||||| | | | | \}}|j|}||d<d}|dk(r|r|j|}|xs||d<|jjdi|y)zh Perform different actions on device based on parameters passed in the playbook rrrr r rrrrrrrVrWstateF)changedr9r6zFetched the device details %spresentr9absentroN)r r#dictrd get_sds_idr;r)r%r& to_modify can_modify create_device show_outputr^ exit_json)r+rrrr r rrrrrrrVrWrnresultr9r add_changed modify_dictremove_changeds r.perform_module_operationz(PowerFlexDevice.perform_module_operationts  ;;--.@Akk((7 KK&&{3 ;;%%j1##H- KK../BC++,,->?#{{112HI!%!3!34L!M!%!3!34L!M#{{112HI%)[[%7%7 (&*"[['' 5  ""7+  &&{I'76 K __X.F001A171:< &t,I-^1DE   I ' (BD  , *.););$k9f#%68L*,@*,F * & ;"--i8N'5F# $ H !// :N(9>y ''rec \| r|s|r|j| } |r|j|| }|r|j|| }|j|| |||||j ||||| || } | r;|j ||}|d}dt |z}tj||| fS)N)rr r6z6Device created successfully, fetched device details %s) get_protection_domain_idget_storage_pool_idget_acceleration_pool_idrlr[r;r)r%r&)r+rrrr rrrrrrrVrWr{r9rs r.rwzPowerFlexDevice.create_devices "&*@#'#@#@&$(  "66!#79O "#'#@#@&(<$>  $$Y%?%4%6%9%;  = ook3C&,oz&:&@B  !44'58N&t,IN+-C HHSM+%%recp|r4d}tj||jj|yy)NzPModification of device attributes is currently not supported by Ansible modules.r)r%r&r r*)r+r|r:s r.rvzPowerFlexDevice.can_modifys2 >I HHY  KK ! !i ! 0 rec|r:|j||}|r|d}dd|d}tj||Sd}tj||jj |S)N)rrr6z/Fetched the acceleration pool details with id ' ', name 'r>zuProtection domain name/id is required to uniquely identify a acceleration pool, only acceleration_pool_name is given.r)rRr%r&r r*)r+rrrQrrr:s r.rz(PowerFlexDevice.get_acceleration_pool_ids (,(B(B'=%9)C); %)'@'F$%9%;=C HHSM$# 8I HHY  KK ! !i ! 0##rec|r:|j||}|r|d}dd|d}tj||Sd}tj||jj |S)N)rrr6z*Fetched the storage pool details with id 'rr>zkProtection domain name/id is required to uniquely identify a storage pool, only storage_pool_name is given.r)rMr%r&r r*)r+rrrLrrr:s r.rz#PowerFlexDevice.get_storage_pool_ids #'#8#8"3%9$9$; $"6t"<.0ACC HHSM .I HHY  KK ! !i ! 0recr|j|}|r|d}dd|d}tj||S)Nr6z/Fetched the protection domain details with id 'rr>)rGr%r&)r+rrFrrs r.rz(PowerFlexDevice.get_protection_domain_idsD// "$ #-d#3 !5!79  ##recr|j|}|r|d}dd|d}tj||S)Nr6z!Fetched the SDS details with id 'rr>)rBr%r&)r+r rAr rs r.rtzPowerFlexDevice.get_sds_ids:ll8,  &Fx!   rec6 |jjjd|i}t|dk(rd|z}tj |yd|dvr+|ddr#|j |dd}|d|dd <d |dvrU|dd rM|j|dd  }|d|dd <|d }||dd <|j|}|d|dd<d|dvrU|ddrM|j|dd}|d|dd<|d }||dd <|j|}|d|dd<|dS#t$rM} d|dt| d} tj | |jj| Yd} ~ yd} ~ wwxYw)zShow device details :param device_id: ID of the device :type device_id: str :return: Details of device :rtype: dict r6r3rz%Device with identifier '%s' not foundNr2)r r5sdsName storagePoolId)rstoragePoolNamerJ)rprotectionDomainNameaccelerationPoolId)raccelerationPoolNamezFailed to get the device 'r=r>r)r$rr7r8r%r(rBrMrGrRr'r)r r*) r+rr9rrA sp_detailspd_idrF ap_detailsr-r:s r.rxzPowerFlexDevice.show_output(s-. 1!0077;;#Y/<1N>"a'= I #.++q0A'0J"ll.2CG2LlM /:6/Bq!),."33&q)/:!22$21$5o$F3H 7A&7Iq!"34"#78:?q!"67!77).80 ?!77)7):,*.8/ =Gv recHtttttttttttttgdtgdtddddgtd d  S) zMThis method provide parameter required for the device module on PowerFlex)InvalidNoneReadWrite ReadAndWrite)choices)HDDSSDNVDIMMTr)rprq)requiredtyperboolF)rdefault)rrrr r rrrrrrrVrWrnrU)rsrrrer.rrusr TVtv$&TV#vdf!VHAJ 89Duy(6KL.  rec8t}|jy)zc Create PowerFlex device object and perform actions on it based on user input from playbookN)r r~)objs r.mainrs  C  "re__main__N)r __future__rrrr __metaclass__ DOCUMENTATIONEXAMPLESRETURNansible.module_utils.basicrGansible_collections.dellemc.powerflex.plugins.module_utils.storage.dellr get_loggerr%objectr rurrrrrrer.rs PBB t lP dl \5ex U 1fU 1p(  # zFre