VhԭdZddlmZmZmZeZdZdZdZ ddl m Z ddl m Z e jdZGd d eZd Zd Zd ZdZdZedk(reyy)zT Ansible module for managing Protection Domain on Dell Technologies (Dell) PowerFlex)absolute_importdivisionprint_functiona module: protection_domain version_added: '1.2.0' short_description: Manage Protection Domain on Dell PowerFlex description: - Managing Protection Domain on PowerFlex storage system includes creating, modifying attributes, deleting and getting details of Protection Domain. author: - Bhavneet Sharma (@sharmb5) extends_documentation_fragment: - dellemc.powerflex.powerflex options: protection_domain_name: description: - The name of the protection domain. - Mandatory for create operation. - It is unique across the PowerFlex array. - Mutually exclusive with I(protection_domain_id). type: str protection_domain_id: description: - The ID of the protection domain. - Except for create operation, all other operations can be performed using protection_domain_id. - Mutually exclusive with I(protection_domain_name). type: str protection_domain_new_name: description: - Used to rename the protection domain. type: str is_active: description: - Used to activate or deactivate the protection domain. type: bool network_limits: description: - Network bandwidth limit used by all SDS in protection domain. type: dict suboptions: rebuild_limit: description: - Limit the network bandwidth for rebuild. type: int rebalance_limit: description: - Limit the network bandwidth for rebalance. type: int vtree_migration_limit: description: - Limit the network bandwidth for vtree migration. type: int overall_limit: description: - Limit the overall network bandwidth. type: int bandwidth_unit: description: - Unit for network bandwidth limits. type: str choices: ['KBps', 'MBps', 'GBps'] default: 'KBps' rf_cache_limits: description: - Used to set the RFcache parameters of the protection domain. type: dict suboptions: is_enabled: description: - Used to enable or disable RFcache in the protection domain. type: bool page_size: description: - Used to set the cache page size in KB. type: int max_io_limit: description: - Used to set cache maximum I/O limit in KB. type: int pass_through_mode: description: - Used to set the cache mode. choices: ['None', 'Read', 'Write', 'ReadAndWrite', 'WriteMiss'] type: str state: description: - State of the protection domain. required: true type: str choices: ['present', 'absent'] notes: - The protection domain can only be deleted if all its related objects have been dissociated from the protection domain. - If the protection domain set to inactive, then no operation can be performed on protection domain. - The I(check_mode) is not supported. a - name: Create protection domain dellemc.powerflex.protection_domain: hostname: "{{hostname}}" username: "{{username}}" password: "{{password}}" validate_certs: "{{validate_certs}}" port: "{{port}}" protection_domain_name: "domain1" state: "present" - name: Create protection domain with all parameters dellemc.powerflex.protection_domain: hostname: "{{hostname}}" username: "{{username}}" password: "{{password}}" validate_certs: "{{validate_certs}}" port: "{{port}}" protection_domain_name: "domain1" is_active: true network_limits: rebuild_limit: 10 rebalance_limit: 17 vtree_migration_limit: 14 overall_limit: 20 bandwidth_unit: "MBps" rf_cache_limits: is_enabled: true page_size: 16 max_io_limit: 128 pass_through_mode: "Read" state: "present" - name: Get protection domain details using name dellemc.powerflex.protection_domain: hostname: "{{hostname}}" username: "{{username}}" password: "{{password}}" validate_certs: "{{validate_certs}}" port: "{{port}}" protection_domain_name: "domain1" state: "present" - name: Get protection domain details using ID dellemc.powerflex.protection_domain: hostname: "{{hostname}}" username: "{{username}}" password: "{{password}}" validate_certs: "{{validate_certs}}" port: "{{port}}" protection_domain_id: "5718253c00000004" state: "present" - name: Modify protection domain attributes dellemc.powerflex.protection_domain: hostname: "{{hostname}}" username: "{{username}}" password: "{{password}}" validate_certs: "{{validate_certs}}" port: "{{port}}" protection_domain_name: "domain1" protection_domain_new_name: "domain1_new" network_limits: rebuild_limit: 14 rebalance_limit: 20 overall_limit: 25 bandwidth_unit: "MBps" rf_cache_limits: page_size: 64 pass_through_mode: "WriteMiss" state: "present" - name: Delete protection domain using name dellemc.powerflex.protection_domain: hostname: "{{hostname}}" username: "{{username}}" password: "{{password}}" validate_certs: "{{validate_certs}}" port: "{{port}}" protection_domain_name: "domain1_new" state: "absent" a+ changed: description: Whether or not the resource has changed. returned: always type: bool sample: 'false' protection_domain_details: description: Details of the protection domain. returned: When protection domain exists type: dict contains: fglDefaultMetadataCacheSize: description: FGL metadata cache size. type: int fglDefaultNumConcurrentWrites: description: FGL concurrent writes. type: str fglMetadataCacheEnabled: description: Whether FGL cache enabled. type: bool id: description: Protection domain ID. type: str links: description: Protection domain links. type: list contains: href: description: Protection domain instance URL. type: str rel: description: Protection domain's relationship with different entities. type: str mdmSdsNetworkDisconnectionsCounterParameters: description: MDM's SDS counter parameter. type: dict contains: longWindow: description: Long window for Counter Parameters. type: int mediumWindow: description: Medium window for Counter Parameters. type: int shortWindow: description: Short window for Counter Parameters. type: int name: description: Name of the protection domain. type: str overallIoNetworkThrottlingEnabled: description: Whether overall network throttling enabled. type: bool overallIoNetworkThrottlingInKbps: description: Overall network throttling in KBps. type: int protectedMaintenanceModeNetworkThrottlingEnabled: description: Whether protected maintenance mode network throttling enabled. type: bool protectedMaintenanceModeNetworkThrottlingInKbps: description: Protected maintenance mode network throttling in KBps. type: int protectionDomainState: description: State of protection domain. type: int rebalanceNetworkThrottlingEnabled: description: Whether rebalance network throttling enabled. type: int rebalanceNetworkThrottlingInKbps: description: Rebalance network throttling in KBps. type: int rebuildNetworkThrottlingEnabled: description: Whether rebuild network throttling enabled. type: int rebuildNetworkThrottlingInKbps: description: Rebuild network throttling in KBps. type: int rfcacheAccpId: description: Id of RF cache acceleration pool. type: str rfcacheEnabled: description: Whether RF cache is enabled or not. type: bool rfcacheMaxIoSizeKb: description: RF cache maximum I/O size in KB. type: int rfcacheOpertionalMode: description: RF cache operational mode. type: str rfcachePageSizeKb: description: RF cache page size in KB. type: bool sdrSdsConnectivityInfo: description: Connectivity info of SDR and SDS. type: dict contains: clientServerConnStatus: description: Connectivity status of client and server. type: str disconnectedClientId: description: Disconnected client ID. type: str disconnectedClientName: description: Disconnected client name. type: str disconnectedServerId: description: Disconnected server ID. type: str disconnectedServerIp: description: Disconnected server IP. type: str disconnectedServerName: description: Disconnected server name. type: str sdsSdsNetworkDisconnectionsCounterParameters: description: Counter parameter for SDS-SDS network. type: dict contains: longWindow: description: Long window for Counter Parameters. type: int mediumWindow: description: Medium window for Counter Parameters. type: int shortWindow: description: Short window for Counter Parameters. type: int storagePool: description: List of storage pools. type: list systemId: description: ID of system. type: str vtreeMigrationNetworkThrottlingEnabled: description: Whether V-Tree migration network throttling enabled. type: bool vtreeMigrationNetworkThrottlingInKbps: description: V-Tree migration network throttling in KBps. type: int sample: { "fglDefaultMetadataCacheSize": 0, "fglDefaultNumConcurrentWrites": 1000, "fglMetadataCacheEnabled": false, "id": "7bd6457000000000", "links": [ { "href": "/api/instances/ProtectionDomain::7bd6457000000000", "rel": "self" }, { "href": "/api/instances/ProtectionDomain::7bd6457000000000/ relationships/Statistics", "rel": "/api/ProtectionDomain/relationship/Statistics" }, { "href": "/api/instances/ProtectionDomain::7bd6457000000000/ relationships/Sdr", "rel": "/api/ProtectionDomain/relationship/Sdr" }, { "href": "/api/instances/ProtectionDomain::7bd6457000000000/ relationships/AccelerationPool", "rel": "/api/ProtectionDomain/relationship/AccelerationPool" }, { "href": "/api/instances/ProtectionDomain::7bd6457000000000/ relationships/StoragePool", "rel": "/api/ProtectionDomain/relationship/StoragePool" }, { "href": "/api/instances/ProtectionDomain::7bd6457000000000/ relationships/Sds", "rel": "/api/ProtectionDomain/relationship/Sds" }, { "href": "/api/instances/ProtectionDomain::7bd6457000000000/ relationships/ReplicationConsistencyGroup", "rel": "/api/ProtectionDomain/relationship/ ReplicationConsistencyGroup" }, { "href": "/api/instances/ProtectionDomain::7bd6457000000000/ relationships/FaultSet", "rel": "/api/ProtectionDomain/relationship/FaultSet" }, { "href": "/api/instances/System::0989ce79058f150f", "rel": "/api/parent/relationship/systemId" } ], "mdmSdsNetworkDisconnectionsCounterParameters": { "longWindow": { "threshold": 700, "windowSizeInSec": 86400 }, "mediumWindow": { "threshold": 500, "windowSizeInSec": 3600 }, "shortWindow": { "threshold": 300, "windowSizeInSec": 60 } }, "name": "domain1", "overallIoNetworkThrottlingEnabled": false, "overallIoNetworkThrottlingInKbps": null, "protectedMaintenanceModeNetworkThrottlingEnabled": false, "protectedMaintenanceModeNetworkThrottlingInKbps": null, "protectionDomainState": "Active", "rebalanceNetworkThrottlingEnabled": false, "rebalanceNetworkThrottlingInKbps": null, "rebuildNetworkThrottlingEnabled": false, "rebuildNetworkThrottlingInKbps": null, "rfcacheAccpId": null, "rfcacheEnabled": true, "rfcacheMaxIoSizeKb": 128, "rfcacheOpertionalMode": "WriteMiss", "rfcachePageSizeKb": 64, "sdrSdsConnectivityInfo": { "clientServerConnStatus": "CLIENT_SERVER_CONN_STATUS_ALL _CONNECTED", "disconnectedClientId": null, "disconnectedClientName": null, "disconnectedServerId": null, "disconnectedServerIp": null, "disconnectedServerName": null }, "sdsConfigurationFailureCounterParameters": { "longWindow": { "threshold": 700, "windowSizeInSec": 86400 }, "mediumWindow": { "threshold": 500, "windowSizeInSec": 3600 }, "shortWindow": { "threshold": 300, "windowSizeInSec": 60 } }, "sdsDecoupledCounterParameters": { "longWindow": { "threshold": 700, "windowSizeInSec": 86400 }, "mediumWindow": { "threshold": 500, "windowSizeInSec": 3600 }, "shortWindow": { "threshold": 300, "windowSizeInSec": 60 } }, "sdsReceiveBufferAllocationFailuresCounterParameters": { "longWindow": { "threshold": 2000000, "windowSizeInSec": 86400 }, "mediumWindow": { "threshold": 200000, "windowSizeInSec": 3600 }, "shortWindow": { "threshold": 20000, "windowSizeInSec": 60 } }, "sdsSdsNetworkDisconnectionsCounterParameters": { "longWindow": { "threshold": 700, "windowSizeInSec": 86400 }, "mediumWindow": { "threshold": 500, "windowSizeInSec": 3600 }, "shortWindow": { "threshold": 300, "windowSizeInSec": 60 } }, "storagePool": [ { "id": "8d1cba1700000000", "name": "pool1" } ], "systemId": "0989ce79058f150f", "vtreeMigrationNetworkThrottlingEnabled": false, "vtreeMigrationNetworkThrottlingInKbps": null } ) AnsibleModule)utilsprotection_domaincreZdZdZdZdZdZdZ ddZdZ d Z d Z dd Z d Z dd ZdZdZdZy)PowerFlexProtectionDomainz'Class with protection domain operationscDtj|_|jjt ddgg}ddgg}t |jd|||_tj|j  tj|j j|_ tjdy#t$rM}tjt||j j!t|Yd}~yd}~wwxYw)z. Define all parameters required by this moduleprotection_domain_nameprotection_domain_idF) argument_specsupports_check_modemutually_exclusiverequired_one_ofz3Got the PowerFlex system connection object instancemsgN)r%get_powerflex_gateway_host_parameters module_paramsupdate*get_powerflex_protection_domain_parametersrmoduleensure_required_libs%get_powerflex_gateway_host_connectionparamspowerflex_connLOGinfo Exceptionerrorstr fail_json)self mut_ex_argsrequired_one_of_argses w/home/dcms/DCMS/lib/python3.12/site-packages/ansible_collections/dellemc/powerflex/plugins/modules/protection_domain.py__init__z"PowerFlexProtectionDomain.__init__s"HHJ !!"L"NO02HIJ !9!7!9 :$,, %*0 2 ""4;;/ ."'"M"M ""#$D  HHJ K . IIc!f  KK ! !c!f ! - - .sAC DADDcgd}d}|D]}|jj|t|jj|jxs+|jj|j ddkDdk(s~|j |}|jj ||jjdq|jjddT|jjdddkr4d }tj||jj |yyyy) zValidate the input parameters)r protection_domain_new_namer zPlease provide the valid {0}N rrnetwork_limits overall_limitz8Overall limit cannot be negative. Provide a valid value ) rrlenstripcountformatr"rr)r# name_paramsrn_itemerr_msg error_msgs r'validate_input_paramsz/PowerFlexProtectionDomain.validate_input_paramss2/ ,! 3F{{!!&)53KK&&v.446<8<9;?F66&<**/%*q<9=>;?**V, %%'%2  3 ;;  . / ;{{!!"23ODPKK&&'78IAM5 # %%)%4 NQ <c|jjds|jjdr4d}tj||jj |yy)z@Checking if protection domain id or new names present in create r*r zprotection_domain_new_name/protection_domain_id are not supported during creation of protection domain. Please try with protection_domain_name.rN)rrrrr")r#r5s r'is_id_or_new_name_in_createz5PowerFlexProtectionDomain.is_id_or_new_name_in_create$sZ ;;  : ; ""#9:JI HHY  KK ! !i ! 0 ;r7cl g}|jjj|}|D]-}t}|d|d<|d|d<|j |/|S#t $rL}d|dt |}tj||jj|Yd}~yd}~wwxYw)z Get Storage pools details :param protection_domain_id: Name of the protection domain :type protection_domain_id: str :return: list containing storage pools which are present in protection domain r idnamez=Failed to get the storage pools present in protection domain z with error rN) rrget_storage_poolsdictappendrr!rr rr")r#r sps_listrespitems sp_name_idr&errmsgs r'get_storage_poolz*PowerFlexProtectionDomain.get_storage_pool/s .H&&88!!7K!L  ,!V #(; 4 %*6] 6" +  , O .3GQQF IIf  KK ! !f ! - -  .sAA B3'AB..B3Nc|r|n|} |r)|jjjd|i}n(|jjjd|i}t|dk(rd|z}tj |y|j |dd|dd<|dS#t$rM}d|d t|d }tj||jj| Yd}~yd}~wwxYw) z Get 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 if exists :rtype: dict r<) filter_fieldsr=rz/Unable to find the protection domain with '%s'.N storagePoolz%Failed to get the protection domain 'z' with error ''r) rrgetr.rrrFrr!r rr")r#r r name_or_id pd_detailsr5r&s r'get_protection_domainz/PowerFlexProtectionDomain.get_protection_domainIs!.B)'  1#!00BBFF#')=">G@ "00BBFF#)+A"BGD :!#$&01 #,0+@+@BCBEEIBK,LJqM- (a=  1(2CF*+  HHSM.04E"5#&="'#&5&G##55DD)="0"A$23D$E*89P*Q"0"A EC *F>/:)*;<)*AB)/:<   /0067K7:1v1? AF/Q8 IIg  KK ! !g ! . . /sB*B-- D*6A*D%%D*c djt|}tj|d|vrK|dF|jj j ||dd|dz}tj|d|vsd|vsd|vrc|jj j||d|d|dd j|d|d|d}tj|y #t$rt}|rd j|t|}nd j|t|}tj||jj| Yd}~yd}~wwxYw)a. Modify Protection domain attributes :param protection_domain_id: ID of the protection domain :type protection_domain_id: str :param rf_modify_dict: Dict containing the attributes of rf cache which are to be updated :type rf_modify_dict: dict :param create_flag: Flag to indicate whether modify operation is followed by create operation or not :type create_flag: bool :return: Boolean indicating if the operation is successful r] is_enabledNz,The RFcache is enabled to '%s' successfully. page_size max_io_limitpass_through_mode)r rfrgrhz4The RFcache parameters are updated to {0}, {1},{2}.'TzcCreate protection domain is successful, but failed to update the rf cache limits {0} with error {1}zLFailed to update the rf cache limits of protection domain {0} with error {1}r) r1r!rrrrset_rfcache_enabledrfcache_parametersrr rr")r#r rf_modify_dictrbrr&r4s r'modify_rf_limitsz*PowerFlexProtectionDomain.modify_rf_limitss& /=s>*+  HHSM~-"<0<##55II(.*FHD&|45 n,"1#&9^&K##55HH)=,[9!/!?&45H&I IK MVN;7*>:*+>?A  /0067K7:1v1? AF/Q8 IIg  KK ! !g ! . . /sC-C00 E-9A*E((E-c dt|z}tj|d|vrF|jjj ||dd|dz}tj|d|vrK|drF|jjj ||dd|dz}tj|d|vrK|dsF|jjj||dd|dz}tj|y#t$rt}|rdj|t|}nd j|t|}tj||jj| Yd }~y d }~wwxYw) a4 Modify Protection domain attributes :param protection_domain_id: ID of the protection domain :type protection_domain_id: str :param modify_dict: Dictionary containing the attributes of protection domain which are to be updated :type modify_dict: dict :param create_flag: Flag to indicate whether modify operation is followed by create operation or not :type create_flag: bool :return: Boolean indicating if the operation is successful zCDictionary containing attributes which need to be updated are '%s'.r*zBThe name of the protection domain is updated to '%s' successfully.rZzOThe protection domain is activated successfully, by setting as is_active: '%s' zQThe protection domain is inactivated successfully, by setting as is_active: '%s' TzeCreate protection domain is successful, but failed to update the protection domain {0} with error {1}z9Failed to update the protection domain {0} with error {1}rN) r!rrrrrenameactivate inactivaterr1r rr")r#r modify_dictrbrr&r4s r'modify_pd_attributesz.PowerFlexProtectionDomain.modify_pd_attributes s* /'*-k*:?@ k)k+.F##55H1;{3KL4!+./ k)+k2J##55J3[5MN7!+./  /0067K7:1v1? ,,2F3G36q6-; IIg  KK ! !g ! . . /sD D F A*FF c, |jjj|tj dy#t $rM}d|dt |d}tj||jj|Yd}~yd}~wwxYw)z Delete Protection Domain :param protection_domain_id: ID of the protection domain :type protection_domain_id: str :return: Boolean indicating if delete operation is successful z'Protection domain deleted successfully.TzDelete protection domain 'rPrJrN) rrdeleterrrr!r rr")r#r r&r5s r'delete_protection_domainz2PowerFlexProtectionDomain.delete_protection_domainCsw 1    1 1 8 89M N HH> ? 1.BCFLI IIi KK ! !i ! 0 0  1s:= BABBc|jjd}|jjd}|jjd}|jjd}|j|jjd}|jjd}|jjd}d}tdd } |j |j ||} | r#| d }d |d |d} t j| d} |j|| |\} } i} i}i}|j| ||||r`t| ||} t| |}t| |}dt| dt|dt|} t j| d}td|jD}td|jD}|s|dk(r|j!| d || }|s|dk(r|j#| d || }| r|dk(r|j%| d | | }|r8|j | d } dt| z} t j| d}|dk(r| r|j'| d }| s|s|rd}|dk(r|j | d } | | d<|| d<|jj(di| y )zs Perform different actions on protection domain based on parameters passed in the playbook r r r*rZr,rYrUFN)changedprotection_domain_detailsr<z/Fetched the protection domain details with id 'z ', name 'rJz*Parameters to be modified are as follows: r+z, c3$K|]}|du ywN.0values r' zEPowerFlexProtectionDomain.perform_module_operation..ME%4-Mc3$K|]}|du ywrzr{r|s r'rzEPowerFlexProtectionDomain.perform_module_operation..rrrTr;z2Protection domain details after modification: '%s'absentTrxrwr{)rrconvert_limits_in_kbpsr?r6rNrrrWr[ to_modifyto_nw_limit_modifyto_rf_limit_modifyr!allvaluesrcrlrrru exit_json)r#r r r*rZr,rYrUrwresultrMrcreate_changedrqrarkmodify_changed is_nw_limit is_rf_limitdelete_changeds r'perform_module_operationz2PowerFlexProtectionDomain.perform_module_operationTs7 "&!3!34L!M#{{112HI%)[[%7%7 (&*"KK&&{3 44 KK  / 02++,,->? ""7+&*  ""$//0F0DF  #-d#3 13IKC HHSM%) $ $UJ%; = #    " ":~#2#=y J$J0J$-/K/ NKN/ OLN%s>':(*C HHSMM^5J5J5LMM M^5J5J5LMM u 1!22:d3C3A3ACNu 1!22:d3C3A3ACN 5I-!$$Z%5{%35  33%/%547J O,C HHSM H !((D)9:  ^~G I 33%/%547J2!"345-;BC6783ABY3ZK/ 0 / * 6=>/0+9/+JK ( r7ci}|td|d<d|d<d|d<d|d<|d|d|dk7r|d|d<|d|d|dk7r|d|d<|d|d|dk7r|d|d<|d|d |dk7r|d|d<|S) ai Check if modification required for RF cache for protection domain :param pd_details: Details of the protection domain :type pd_details: dict :param rf_cache_limits: dict for RF cache :type rf_cache_limits: dict :return: Dictionary containing the attributes of protection domain which are to be updated :rtype: dict NrerfrgrhrfcacheEnabledrfcachePageSizeKbrfcacheMaxIoSizeKbrfcacheOpertionalModer{)rMrYrqs r'rrsK"$( L!#' K &* N#+/ '( < ( 4DT9U -:.(7 (EK % ; ' 3 CV8W ,9-'6{'CK $ > * 6:FZ;[/<0*9.*IK ' . / ;23GZ7[[/>?R/SK+ , r7ctttttdtdttdtdtdtdtgdd tdttdtdtdtgd    td dddgS)zZThis method provides parameters required for the protection domain module on PowerFlexbool)typer?int)KBpsrrr)choicesdefault)r^r_r`r-r)roptions)NoneReadWrite ReadAndWrite WriteMiss)r)rerfrgrhTr!rTr)requiredrr)r r*r rZr,rYrUrr{r7r'rrCs #v#'6!VF#". $% 0&*&6".#,D,2 4 "  V,E*!u-"&0M#N " Duy(6KL1 r7c8t}|jy)zn Create PowerFlex protection domain object and perform actions on it based on user input from playbookN)r r)objs r'mainrbs $ %C  "r7__main__N)r __future__rrrr __metaclass__ DOCUMENTATIONEXAMPLESRETURNansible.module_utils.basicrGansible_collections.dellemc.powerflex.plugins.module_utils.storage.dellr get_loggerrobjectr rrrrrrr{r7r'rs [BB _ BQ fh T 5e*+bbJ>'T"J># zFr7