VhHdZddlmZmZmZeZdZdZdZ ddl m Z ddl m Z ddlmZdd lmZdd lZe j&d Zd Zd ZdZGddeZdZGddZGddZGddZGddZGddZGddZdZ e!dk(re y y ) z? Ansible module for managing SDT on Dell Technologies PowerFlex)absolute_importdivisionprint_functiona module: sdt version_added: '2.6.0' short_description: Manage SDT (also called NVMe Target) on Dell PowerFlex description: - Managing SDT (also called NVMe Target) on PowerFlex storage system includes creating new SDT, getting details of SDT, managing IP or role of SDT, modifying attributes of SDT, and deleting SDT. - Support only for Powerflex 4.5 versions and above. author: - Yuhao Liu (@RayLiu7) extends_documentation_fragment: - dellemc.powerflex.powerflex options: discovery_port: description: - Discovery port of the SDT. type: int maintenance_mode: description: - Maintenance mode state of the SDT. choices: ['active', 'inactive'] type: str nvme_port: description: - NVMe port of the SDT. type: int protection_domain_name: description: - The name of the protection domain. type: str sdt_ip_list: description: - Dictionary of IPs and their roles for the SDT. - At least one IP-role is mandatory while creating a SDT. - IP-roles can be updated as well. type: list elements: dict suboptions: ip: description: - IP address of the SDT. type: str required: true role: description: - Role assigned to the SDT IP address. choices: ['StorageOnly', 'HostOnly', 'StorageAndHost'] type: str required: true sdt_name: description: - The name of the SDT. - Mandatory for all operations. - It is unique across the PowerFlex array. required: true type: str sdt_new_name: description: - SDT new name, can only be used for renaming the SDT. - Only used for updates. Ignored during creation. type: str state: description: - State of the SDT. choices: ['present', 'absent'] default: present type: str storage_port: description: - Storage port of the SDT. type: int attributes: check_mode: description: Runs task to validate without performing action on the target machine. support: full diff_mode: description: Runs the task to report the changes made or to be made. support: full notes: - IP addresses, and IP address roles must be configured for each SDT. - You can assign both storage and host roles to the same target IP addresses. - Alternatively, assign the storage role to one target IP address, and add another target IP address for the host role. - Both roles must be configured on each NVMe target. af - name: Create SDT dellemc.powerflex.sdt: hostname: "{{ hostname }}" username: "{{ username }}" password: "{{ password }}" validate_certs: "{{ validate_certs }}" sdt_name: "sdt_example" sdt_ip_list: - ip: "172.169.xx.xx" role: "StorageAndHost" - ip: "172.169.yy.yy" role: "StorageAndHost" protection_domain_name: "PD1" storage_port: 12200 nvme_port: 4420 discovery_port: 8009 state: "present" - name: Rename SDT dellemc.powerflex.sdt: hostname: "{{ hostname }}" username: "{{ username }}" password: "{{ password }}" validate_certs: "{{ validate_certs }}" sdt_name: "sdt_example" sdt_new_name: "sdt_new_example" state: "present" - name: Modify SDT port dellemc.powerflex.sdt: hostname: "{{ hostname }}" username: "{{ username }}" password: "{{ password }}" validate_certs: "{{ validate_certs }}" sdt_name: "sdt_example" nvme_port: 4421 discovery_port: 8008 state: "present" - name: Change maintenance mode dellemc.powerflex.sdt: hostname: "{{ hostname }}" username: "{{ username }}" password: "{{ password }}" validate_certs: "{{ validate_certs }}" sdt_name: "sdt_example" maintenance_mode: "active" state: "present" - name: Set IP and role to SDT dellemc.powerflex.sdt: hostname: "{{ hostname }}" username: "{{ username }}" password: "{{ password }}" validate_certs: "{{ validate_certs }}" sdt_name: "sdt_example" sdt_ip_list: - ip: "172.169.xx.xx" role: "StorageAndHost" - ip: "172.169.zz.zz" role: "StorageAndHost" state: "present" - name: Remove SDT dellemc.powerflex.sdt: hostname: "{{ hostname }}" username: "{{ username }}" password: "{{ password }}" validate_certs: "{{ validate_certs }}" sdt_name: "sdt_example" state: "absent" ak changed: description: Whether or not the resource has changed. returned: always type: bool sample: 'false' sdt_details: description: Details of the SDT. returned: When SDT exists type: dict contains: authenticationError: description: Indicates authentication error. type: str certificateInfo: description: Information about certificate. type: dict contains: issuer: description: Issuer of the certificate. type: str subject: description: Subject of the certificate. type: str thumbprint: description: Thumbprint of the certificate. type: str validFrom: description: Date and time the certificate is valid from. type: str validFromAsn1Format: description: Valid from date in ASN.1 format. type: str validTo: description: Date and time the certificate is valid to. type: str validToAsn1Format: description: Valid to date in ASN.1 format. type: str discoveryPort: description: Discovery port. type: int faultSetId: description: Fault set ID. type: str id: description: SDS ID. type: str ipList: description: SDS IP list. type: list contains: ip: description: IP present in the SDS. type: str role: description: Role of the SDS IP. type: str links: description: SDS links. type: list contains: href: description: SDS instance URL. type: str rel: description: SDS's relationship with different entities. type: str maintenanceState: description: Maintenance state. type: str mdmConnectionState: description: MDM connection state. type: str membershipState: description: Membership state. type: str name: description: Name of the SDS. type: str nvmePort: description: NVMe port. type: int persistentDiscoveryControllersNum: description: Number of persistent discovery controllers. type: int protectionDomainId: description: Protection Domain ID. type: str protectionDomainName: description: Protection Domain Name. type: str sdtState: description: SDS state. type: str softwareVersionInfo: description: SDS software version information. type: str storagePort: description: Storage port. type: int systemId: description: System ID. type: str sample: { "authenticationError": "None", "certificateInfo": { "issuer": "/GN=MDM/CN=CA-804696a4dbe1d90f/L=Hopkinton/ST=Massachusetts/C=US/O=EMC/OU=ASD", "subject": "/GN=sdt-comp-0/CN=host41/L=Hopkinton/ST=Massachusetts/C=US/O=EMC/OU=ASD", "thumbprint": "07:1E:FC:48:03:42:E6:45:14:1D:AA:97:1F:4F:B9:B2:B4:11:99:09", "validFrom": "Oct 8 02:35:00 2024 GMT", "validFromAsn1Format": "241008023500Z", "validTo": "Oct 7 03:35:00 2034 GMT", "validToAsn1Format": "341007033500Z" }, "discoveryPort": 8009, "faultSetId": null, "id": "917d28ed00000000", "ipList": [ { "ip": "172.169.xx.xx", "role": "StorageAndHost" }, { "ip": "172.169.yy.yy", "role": "StorageAndHost" } ], "links": [ { "href": "/api/instances/Sdt::917d28ed00000000", "rel": "self" }, { "href": "/api/instances/Sdt::917d28ed00000000/relationships/Statistics", "rel": "/api/Sdt/relationship/Statistics" }, { "href": "/api/instances/ProtectionDomain::b4787fa100000000", "rel": "/api/parent/relationship/protectionDomainId" } ], "maintenanceState": "NoMaintenance", "mdmConnectionState": "Connected", "membershipState": "Joined", "name": "Sdt-pf460-svm-1", "nvmePort": 4420, "persistentDiscoveryControllersNum": 0, "protectionDomainId": "b4787fa100000000", "protectionDomainName": "PD1", "sdtState": "Normal", "softwareVersionInfo": "R4_5.2100.0", "storagePort": 12200, "systemId": "804696a4dbe1d90f" } ) AnsibleModule)utils) PowerFlexBase) ConfigurationNsdtzXProvide valid values for sdt_ip_list as 'ip' and 'role' for Create or Modify operations.zIProvide valid value for name for the creation or modification of the SDT.zTProtection Domain is a mandatory parameter for creating an SDT. Enter a valid value.ceZdZdZfdZdZddZdZdZ ddZ dZ dd Z d Z d Z d Zd ZdZdZdZdZdZxZS) PowerFlexSDTzClass with SDT operationsctj|_|jjt t dd}t |t||jjdiidy)z-Define all parameters required by this moduleT) argument_specsupports_check_modeF)changed sdt_detailsdiffN) r%get_powerflex_gateway_host_parameters module_paramsupdateget_powerflex_sdt_parameterssuper__init__rresult)selfansible_module_params __class__s i/home/dcms/DCMS/lib/python3.12/site-packages/ansible_collections/dellemc/powerflex/plugins/modules/sdt.pyrzPowerFlexSDT.__init__csj"HHJ !!">"@A:;#'!  (=> uRLMc|t|dk(r8t}tj||jj |yy)zValidate the input parametersNrmsg)lenSDT_IP_LIST_INVALID_ERROR_MSGLOGerrormodule fail_json)r sdt_ip_list error_msgs rvalidate_ip_parameterz"PowerFlexSDT.validate_ip_parameterqsA  #k"2a"75I IIi KK ! !i ! 0#8rc|r|n|} |r)|jjjd|i}n(|jjjd|i}t|dk(rd|z}tj |y|dS#t $rM}d|dt|d }tj||jj| Yd}~yd}~wwxYw) zGet SDT details :param sdt_name: Name of the SDT :type sdt_name: str :param sdt_id: ID of the SDT :type sdt_id: str :return: Details of SDT if it exists :rtype: dict name filter_fieldsidr"SDT with identifier '%s' not foundNFailed to get the SDT '' with error ''r ) powerflex_connr getr"r$info Exceptionstrr%r&r')rsdt_namesdt_id id_or_namerr!er)s rget_sdt_detailszPowerFlexSDT.get_sdt_detailsys &V8  1"115599#)8"4: #115599v9W ;1$:ZG q> ! 1AI IIi KK ! !i ! 0 0  1sA;B B CACCc|ddk(riSi}||d|d|d|d|d|dd }|Stj|}|j||}|jD] }||||< |S) zGet diff between playbook input and sdt details :param sdt_params: Dictionary of parameters input from playbook :param sdt_params: Dictionary of sdt details :return: Dictionary of parameters of differencesstateabsentdiscovery_port nvme_portprotection_domain_namer(r9 storage_port)rArBrCr(r9rD)copydeepcopyis_sdt_modify_requiredkeys)r sdt_paramsr diff_dict modify_dictkeys rget_diff_afterzPowerFlexSDT.get_diff_afters g ( *II"&01A&B!+K!8.89Q.R#-m#< *: 6$.~$>    !MM+6 "99*iP &++-6C%0%5IcN6 rc |j||d|d|d|d|d}|dr*|j|d|d\}}}|s|s|r|d|d<|S) z Check if the SDT needs to be modified. :param sdt_params: Dictionary of parameters input from playbook :param sdt_details: Dictionary of sdt details :return: Dictionary of parameters of differences sdt_new_namerDrBrAmaintenance_moderrOrDrBrArPr(ipList) to_modifyclassify_ip_list_change)rrIrrK ips_to_add ips_to_removeroles_to_updates rrGz#PowerFlexSDT.is_sdt_modify_requiredsnn##N3#N3 -%&67'(:; %  m $9=9U9U=);x+@: 6J ]o(2=(A H%rcdt|j|jj||S)zRGet the details of a protection domain in a given PowerFlex storage system)rCprotection_domain_id)r r4r&get_protection_domain)rrCrYs rrZz"PowerFlexSDT.get_protection_domains4 T00$++>TT#9!5U  rcB|t|jdk(r7t}tj ||j j ||7t}tj ||j j ||j|y)Nrr ) r"stripSDT_NAME_INVALID_ERROR_MSGr$r%r&r'PD_INVALID_ERROR_MSGr*)rrYr(r9r)s rvalidate_createzPowerFlexSDT.validate_creates{  s8>>#3492I IIi KK ! !i ! 0  ',I IIi KK ! !i ! 0 "";/rc  |j||||jjsUd|d|d|d|d|d| }tj d||j j j|||||| |j| S#t$rL}d |d t|} tj| |jj| Yd}~yd}~wwxYw)aOCreate SDT :param protection_domain_id: ID of the Protection Domain :type protection_domain_id: str :param sdt_ip_list: List of one or more IP addresses and their roles :type sdt_ip_list: list[dict] :param sdt_name: SDT name :type sdt_name: str :param storage_port: Storage port of SDT :type storage_port: int :param nvme_port: NVMe port of SDT :type nvme_port: int :param discovery_port: Discovery port of SDT :type discovery_port: int :return: dict )rYr(r9zprotection_domain_id: z, sdt_ip_list: z , sdt_name: z, storage_port: z , nvme_port: z, discovery_port: zCreating SDT with params: %s)rYsdt_ipsr9rDrBrA)r9z Create SDT z operation failed with error r N) r_r& check_moder$r6r4r creater=r7r8r%r') rrYr(r9rDrBrA create_paramsr<r)s r create_sdtzPowerFlexSDT.create_sdts2) 1  %9'! !  ;;))-# $!&  7G##''..)='%!-'#1 /''': : 1%hZ/LSQRVHUI IIi KK ! !i ! 0 0 1sBB C(AC##C(ci}| ||dk7r||d<| ||dk7r||d<| ||dk7r||d<| ||dk7r||d<|$|dk(r |ddk7rd|d<|dk(r |dd k7rd|d<|S) am :param sdt_details: Details of the SDT :type sdt_details: dict :param sdt_new_name: New name of SDT :type sdt_new_name: str :param storage_port: Storage port of SDT :type storage_port: int :param nvme_port: NVMe port of SDT :type nvme_port: int :param discovery_port: Discovery port of SDT :type discovery_port: int :param maintenance_mode: Maintenance mode of SDT :type maintenance_mode: str :return: Dictionary containing the attributes of SDT which are to be updated :rtype: dict r, storagePortnvmePort discoveryPortactivemaintenanceState InMaintenanceinactive NoMaintenance)rrrOrDrBrArPrKs rrSzPowerFlexSDT.to_modify)s4  # F8K(K".K   # M8R(R)5K &  Y+j2I%I&/K #  &+o">>+9K (  ' H, 23F2: ./ J. 23F2< ./rc| dt|z}tj||jjsd|vrF|j j j||dd|dz}tj|d|vrF|j j j||dd|dz}tj|d|vrF|j j j||dd|dz}tj|d|vrF|j j j||dd |dz}tj|d |vr||j j j|j j jd }|j|d }|r%||d |d z}tj|y #t$rM}d|dt|d}tj||jj!|Yd}~yd}~wwxYw)aV Modify SDT attributes :param sdt_id: SDT ID :type sdt_id: str :param modify_dict: Dictionary containing the attributes of SDT which are to be updated :type modify_dict: dict :return: Boolean indicating if the operation is successful zADictionary containing attributes which are to be updated is '%s'.r,z4The name of the SDT is updated to '%s' successfully.rgz1The storage port is updated to '%s' successfully.rhz.The nvme port is updated to '%s' successfully.riz3The discovery port is updated to '%s' successfully.rk)rjrmz5The maintenance mode is updated to '%s' successfully.TzFailed to update the SDT 'r2r3r N)r8r$r6r&rbr4r renameset_storage_port set_nvme_portset_discovery_portenter_maintenance_modeexit_maintenance_moder5r7r%r')rr:rKr!mode_map mode_funcr<r)s rmodify_sdt_attributesz"PowerFlexSDT.modify_sdt_attributes`s>C 1$'*;'79  HHSM;;))[(''++226;v;NON%f-.HHSM K/''++<< M :L%m45HHSM,''++99 J 7I%j12HHSM"k1''++>> O <N%o67HHSM%4"&"5"5"9"9"P"P$($7$7$;$;$Q$Q H!) [9K-L MI !&)S)*<=>  1AI IIi KK ! !i ! 0 0  1sG"G%% H;.AH66H;c<g}g}g}|D](tfd|Dr|j*|D](tfd|Dr|j*|D]2|D]+}|ddk(s|ddk7s|j-4|||fS)Nc34K|]}|ddk(ywipNro.0ip_dest ip_sources r z7PowerFlexSDT.classify_ip_list_change..s#5< 40c34K|]}|ddk(ywr|ror~s rrz7PowerFlexSDT.classify_ip_list_change..sSGwt} $7Srr}role)anyappend)rr(sdt_details_ip_listrUrVrWrrs @rrTz$PowerFlexSDT.classify_ip_list_changes  % -I@S!!),  -- 0IS{SS$$Y/ 0 % 6I. 6DMYt_49V+<<#**95  6 6=/99rc |jjsf|D]a}tjd|d|jj j |d|d|dtjdcy#t$rP}d|d d t|d }tj||jj| Yd }~y d }~wwxYw)a9Add IP to SDT :param sdt_details: Details of the SDT :type sdt_details: str :param sdt_ip_list: List of one or more IP addresses and their roles :type sdt_ip_list: list[dict] :return: Boolean indicating if add IP operation is successful z IP to add: %sr}r/rr:r}rzIP added successfully.TzAdd IP to SDT 'r,' operation failed with error 'r3r N) r&rbr$r6r4r add_ipr7r8r%r'rrr(r}r<r)s rrzPowerFlexSDT.add_ips 1;;))%7BHH_bh7''++22*40RXBvJ3HH56 7  1F#AI IIi KK ! !i ! 0 0  1sAAA B/AB**B/c |jjjd|i}t|dk(rd|z}tj |yd|dvr+|ddr#|j |dd}|d|dd <|dS#t$rM}d |d t|d }tj ||jj| Yd}~yd}~wwxYw)zShow SDT details :param sdt_id: ID of the SDT :type sdt_id: str :return: Details of SDT :rtype: dict r/r-rr0NprotectionDomainId)rYr,protectionDomainNamer1r2r3r ) r4r r5r"r$r%rZr7r8r&r')rr:rr! pd_detailsr<r)s r show_outputzPowerFlexSDT.show_output2s 1--1155T6N5SK;1$:VC #% A6N#78!77)4Q8L)M8 :DF9K A56q> ! 1HNPSTUPVWI IIi KK ! !i ! 0 0 1sAB 6B C ACC c|d|dg}|D]Y}|t|jdk(s#t}tj ||j j |[y)Nr9rOrr )r"r\r]r$r%r&r')rrIparamsparamr)s rvalidate_nameszPowerFlexSDT.validate_namesSscZ(*^*DE 5E S%71%<6  )$ %%)%4  5r)NN)NNN)__name__ __module__ __qualname____doc__rr*r=rMrGrZr_rerSryrTrrrrrr __classcell__)rs@rr r `su# N1!1F40AE  0&B1H5nM1^:<14141<1&1B5rr c,ttdtttddttdtdgdtd td td td d d gtd ddgd S)zKThis method provide parameters required for the SDT module on PowerFlexT)requiredlistdict)StorageAndHost StorageOnlyHostOnly)rchoices)r}r)typeelementsoptionsint)rr8rjrm)rrpresentr@)rrdefault) r9rOrCr(rDrBrArPr?)rrorrrr\s t$V#v&!+X  u%E"'58Z2HI 8'>2rNrrrrrrorrrrus +3rrceZdZdZdZy)SDTDeleteHandlerz,SDT Handler to process the delete operation.c|ddk(r"|r |j|}d|jd<tj||y)Nr?r@Tr)rrrr)rrrIrs rrzSDTDeleteHandler.handlesB g ( *{!,,[9K(,GNN9 %5rNrrorrrrs 66rrceZdZdZdZy)SDTChangeIPListHandlerz4SDT Handler to process the IP list change operation.cL|ddk(r|r|r}|s{|j||j||d\}}}|r|j|||r|j|||r|j |||s|s|rd|j d<t j|||y)Nr?rrRTr)r*rTrrrrrr) rrrIrcreate_sdt_flagr(rUrVrWs rrzSDTChangeIPListHandler.handles w 9 ,#  ) )+ 6// [=RS 7J {J7##KA!!+}=_ ,0y)!!':{CrNrrorrrrs >DrrceZdZdZdZy)SDTModifyHandlerz6SDT Handler to process the attribute modify operation.c |ddk(rQ|rO|sM|j||d|d|d|d|d}|r%|j|d | d |jd <tj |||||y) Nr?rrOrDrBrArPrQr/)r:rKTr)rSryrrr)rrrIrrr(rKs rrzSDTModifyHandler.handles g ) + O!++''7'7$[1)*:;!+,>!? ,K--&t,+.-1y) '' Zo{ rNrrorrrrs @ rrceZdZdZdZy)SDTCreateHandlerz,SDT Handler to process the create operation.c d}tj|d}|ddk(r6|s4|j|d|||d|d|d }d |jd <d }t j |||||y) NFr(r?rr9rDrBrA)r9rYr(rDrBrATr)rErFrerrr)rrrIrrYrr(s rrzSDTCreateHandler.handlesmmJ}$=> g ) +K!,,#J/%9''7$[1)*:; -K)-GNN9 %"O!! Zo{ rNrrorrrrs 6 rrceZdZdZdZy) SDTHandlerz(SDT Handler to preprocess the operation.c`|j||j|d}d}|dr|j|dd}i}i}|j||}|i}n|}|jj rt |||jd<tj||||y)N)rIr9rC)rCr/)beforeafterr) rr=rZrMr&_diffrrrr)rrrIrrY before_dictrJs rrzSDTHandler.handles*5--j.DE # . /#*#@#@'12J'K$A$$   **:{C  K%K >>  %)I%NGNN6 "!! Z.B rNrrorrrrs 2 rrctt}tj||jjy)z[Create PowerFlex SDT object and perform action on it based on user input from playbook.N)r rrr&r)objs rmainrs' .CLSZZ../r__main__)"r __future__rrrr __metaclass__ DOCUMENTATIONEXAMPLESRETURNansible.module_utils.basicrGansible_collections.dellemc.powerflex.plugins.module_utils.storage.dellr`ansible_collections.dellemc.powerflex.plugins.module_utils.storage.dell.libraries.powerflex_baser_ansible_collections.dellemc.powerflex.plugins.module_utils.storage.dell.libraries.configurationr rE get_loggerr$r#r]r^r rrrrrrrrrrorrrs F@@ V pH T[ z5 eu zOny5=y5x2 3 366DD8  0  .  60 zFr