diff --git a/ChangeLog.md b/ChangeLog.md index 8c27b70..fecb324 100644 --- a/ChangeLog.md +++ b/ChangeLog.md @@ -1,4 +1,10 @@ # ansible-unity Change Log +## Version 1.2.1 - released on 28/09/21 +- Fixed typo in galaxy.yml +- Updated few samples in modules +- Added dual licensing +- Documentation updates + ## Version 1.2.0 - released on 25/06/21 - Added support for Application tagging. - Added CRUD operations support for User Quota on Filesystem/Quota tree. diff --git a/LICENSE b/LICENSE index 261eeb9..e72bfdd 100644 --- a/LICENSE +++ b/LICENSE @@ -1,201 +1,674 @@ - Apache License - Version 2.0, January 2004 - http://www.apache.org/licenses/ - - TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION - - 1. Definitions. - - "License" shall mean the terms and conditions for use, reproduction, - and distribution as defined by Sections 1 through 9 of this document. - - "Licensor" shall mean the copyright owner or entity authorized by - the copyright owner that is granting the License. - - "Legal Entity" shall mean the union of the acting entity and all - other entities that control, are controlled by, or are under common - control with that entity. For the purposes of this definition, - "control" means (i) the power, direct or indirect, to cause the - direction or management of such entity, whether by contract or - otherwise, or (ii) ownership of fifty percent (50%) or more of the - outstanding shares, or (iii) beneficial ownership of such entity. - - "You" (or "Your") shall mean an individual or Legal Entity - exercising permissions granted by this License. - - "Source" form shall mean the preferred form for making modifications, - including but not limited to software source code, documentation - source, and configuration files. - - "Object" form shall mean any form resulting from mechanical - transformation or translation of a Source form, including but - not limited to compiled object code, generated documentation, - and conversions to other media types. - - "Work" shall mean the work of authorship, whether in Source or - Object form, made available under the License, as indicated by a - copyright notice that is included in or attached to the work - (an example is provided in the Appendix below). - - "Derivative Works" shall mean any work, whether in Source or Object - form, that is based on (or derived from) the Work and for which the - editorial revisions, annotations, elaborations, or other modifications - represent, as a whole, an original work of authorship. For the purposes - of this License, Derivative Works shall not include works that remain - separable from, or merely link (or bind by name) to the interfaces of, - the Work and Derivative Works thereof. - - "Contribution" shall mean any work of authorship, including - the original version of the Work and any modifications or additions - to that Work or Derivative Works thereof, that is intentionally - submitted to Licensor for inclusion in the Work by the copyright owner - or by an individual or Legal Entity authorized to submit on behalf of - the copyright owner. For the purposes of this definition, "submitted" - means any form of electronic, verbal, or written communication sent - to the Licensor or its representatives, including but not limited to - communication on electronic mailing lists, source code control systems, - and issue tracking systems that are managed by, or on behalf of, the - Licensor for the purpose of discussing and improving the Work, but - excluding communication that is conspicuously marked or otherwise - designated in writing by the copyright owner as "Not a Contribution." - - "Contributor" shall mean Licensor and any individual or Legal Entity - on behalf of whom a Contribution has been received by Licensor and - subsequently incorporated within the Work. - - 2. Grant of Copyright License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - copyright license to reproduce, prepare Derivative Works of, - publicly display, publicly perform, sublicense, and distribute the - Work and such Derivative Works in Source or Object form. - - 3. Grant of Patent License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - (except as stated in this section) patent license to make, have made, - use, offer to sell, sell, import, and otherwise transfer the Work, - where such license applies only to those patent claims licensable - by such Contributor that are necessarily infringed by their - Contribution(s) alone or by combination of their Contribution(s) - with the Work to which such Contribution(s) was submitted. If You - institute patent litigation against any entity (including a - cross-claim or counterclaim in a lawsuit) alleging that the Work - or a Contribution incorporated within the Work constitutes direct - or contributory patent infringement, then any patent licenses - granted to You under this License for that Work shall terminate - as of the date such litigation is filed. - - 4. Redistribution. You may reproduce and distribute copies of the - Work or Derivative Works thereof in any medium, with or without - modifications, and in Source or Object form, provided that You - meet the following conditions: - - (a) You must give any other recipients of the Work or - Derivative Works a copy of this License; and - - (b) You must cause any modified files to carry prominent notices - stating that You changed the files; and - - (c) You must retain, in the Source form of any Derivative Works - that You distribute, all copyright, patent, trademark, and - attribution notices from the Source form of the Work, - excluding those notices that do not pertain to any part of - the Derivative Works; and - - (d) If the Work includes a "NOTICE" text file as part of its - distribution, then any Derivative Works that You distribute must - include a readable copy of the attribution notices contained - within such NOTICE file, excluding those notices that do not - pertain to any part of the Derivative Works, in at least one - of the following places: within a NOTICE text file distributed - as part of the Derivative Works; within the Source form or - documentation, if provided along with the Derivative Works; or, - within a display generated by the Derivative Works, if and - wherever such third-party notices normally appear. The contents - of the NOTICE file are for informational purposes only and - do not modify the License. You may add Your own attribution - notices within Derivative Works that You distribute, alongside - or as an addendum to the NOTICE text from the Work, provided - that such additional attribution notices cannot be construed - as modifying the License. - - You may add Your own copyright statement to Your modifications and - may provide additional or different license terms and conditions - for use, reproduction, or distribution of Your modifications, or - for any such Derivative Works as a whole, provided Your use, - reproduction, and distribution of the Work otherwise complies with - the conditions stated in this License. - - 5. Submission of Contributions. Unless You explicitly state otherwise, - any Contribution intentionally submitted for inclusion in the Work - by You to the Licensor shall be under the terms and conditions of - this License, without any additional terms or conditions. - Notwithstanding the above, nothing herein shall supersede or modify - the terms of any separate license agreement you may have executed - with Licensor regarding such Contributions. - - 6. Trademarks. This License does not grant permission to use the trade - names, trademarks, service marks, or product names of the Licensor, - except as required for reasonable and customary use in describing the - origin of the Work and reproducing the content of the NOTICE file. - - 7. Disclaimer of Warranty. Unless required by applicable law or - agreed to in writing, Licensor provides the Work (and each - Contributor provides its Contributions) on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or - implied, including, without limitation, any warranties or conditions - of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A - PARTICULAR PURPOSE. You are solely responsible for determining the - appropriateness of using or redistributing the Work and assume any - risks associated with Your exercise of permissions under this License. - - 8. Limitation of Liability. In no event and under no legal theory, - whether in tort (including negligence), contract, or otherwise, - unless required by applicable law (such as deliberate and grossly - negligent acts) or agreed to in writing, shall any Contributor be - liable to You for damages, including any direct, indirect, special, - incidental, or consequential damages of any character arising as a - result of this License or out of the use or inability to use the - Work (including but not limited to damages for loss of goodwill, - work stoppage, computer failure or malfunction, or any and all - other commercial damages or losses), even if such Contributor - has been advised of the possibility of such damages. - - 9. Accepting Warranty or Additional Liability. While redistributing - the Work or Derivative Works thereof, You may choose to offer, - and charge a fee for, acceptance of support, warranty, indemnity, - or other liability obligations and/or rights consistent with this - License. However, in accepting such obligations, You may act only - on Your own behalf and on Your sole responsibility, not on behalf - of any other Contributor, and only if You agree to indemnify, - defend, and hold each Contributor harmless for any liability - incurred by, or claims asserted against, such Contributor by reason - of your accepting any such warranty or additional liability. - - END OF TERMS AND CONDITIONS - - APPENDIX: How to apply the Apache License to your work. - - To apply the Apache License to your work, attach the following - boilerplate notice, with the fields enclosed by brackets "[]" - replaced with your own identifying information. (Don't include - the brackets!) The text should be enclosed in the appropriate - comment syntax for the file format. We also recommend that a - file or class name and description of purpose be included on the - same "printed page" as the copyright notice for easier - identification within third-party archives. - - Copyright [yyyy] [name of copyright owner] - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. \ No newline at end of file diff --git a/MODULE-LICENSE b/MODULE-LICENSE new file mode 100644 index 0000000..261eeb9 --- /dev/null +++ b/MODULE-LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/README.md b/README.md index 31b5c0c..3fe2af4 100644 --- a/README.md +++ b/README.md @@ -4,17 +4,21 @@ The Ansible Modules for Dell EMC Unity allow Data Center and IT administrators t The capabilities of the Ansible modules are managing consistency groups, filesystem, filesystem snapshots, NAS server, NFS export, SMB share, hosts, snapshots, snapshot schedules, storage pools, user quotas, quota trees and volumes; and to gather facts from the array. The options available for each are list, show, create, modify and delete. These tasks can be executed by running simple playbooks written in yaml syntax. The modules are written so that all the operations are idempotent, so making multiple identical requests has the same effect as making a single request. +## License +Ansible collection for Unity is released and licensed under the GPL-3.0 license. See [LICENSE](LICENSE) for the full terms. Ansible modules and modules utilities that are part of the Ansible collection for Unity are released and licensed under the Apache 2.0 license. See [MODULE-LICENSE](MODULE-LICENSE) for the full terms. + ## Support -Ansible modules for Unity are supported by Dell EMC and are provided under the terms of the license attached to the source code. Dell EMC does not provide support for any source code modifications. For any Ansible module issues, questions or feedback, join the [Dell EMC Automation community](https://www.dell.com/community/Automation/bd-p/Automation). +Ansible collection for Unity are supported by Dell EMC and are provided under the terms of the license attached to the collection. Please see the [LICENSE](#license) section for the full terms. Dell EMC does not provide any support for the source code modifications. For any Ansible modules issues, questions or feedback, join the [Dell EMC Automation Community](https://www.dell.com/community/Automation/bd-p/Automation). ## Supported Platforms * Dell EMC Unity Arrays version 5.0, 5.1.0 ## Prerequisites - * Ansible 2.9, 2.10 - * Python 2.8, 3.5, 3.6, 3.7, 3.8 - * Red Hat Enterprise Linux 7.6, 7.7, 7.8, 8.2 - * Python Library for Unity storops version 1.2.10 or higher +This table provides information about the software prerequisites for the Ansible Modules for Dell EMC PowerMax. + +| **Ansible Modules** | **Red Hat Enterprise Linux** | **Python version** | **Python library version** | **Ansible** | +|---------------------|------------------------------|--------------------|----------------------------|-------------| +| v1.2.1 | 7.6
7.7
7.8
8.2 | 2.8
3.5
3.6
3.7
3.8 | 1.2.10 or higher| 2.9
2.10 | ## Idempotency The modules are written in such a way that all requests are idempotent and hence fault-tolerant. It essentially means that the result of a successfully performed request is independent of the number of times it is executed. @@ -40,29 +44,48 @@ Install python sdk named 'storops'. It can be installed using pip, based on appr pip install storops +## Building Collections + 1. Use the following command to build the collection from source code: + + ansible-galaxy collection build + + For more details on how to build a tar ball, refer: [Building the collection](https://docs.ansible.com/ansible/latest/dev_guide/developing_collections_distributing.html#building-your-collection-tarball) + ## Installing Collections - * Download the tar build and follow the below command to install the collection anywhere in your system: - - ansible-galaxy collection install dellemc-unity-1.2.0.tar.gz -p - * Set the environment variable: - - export ANSIBLE_COLLECTIONS_PATHS=$ANSIBLE_COLLECTIONS_PATHS: +#### Online Installation of Collections + 1. Use the following command to install the latest collection hosted in galaxy: + + ansible-galaxy collection install dellemc.unity -p + +#### Offline Installation of Collections + 1. Download the latest tar build from any of the available distribution channel [Ansible Galaxy](https://galaxy.ansible.com/dellemc/unity) /[Automation Hub](https://console.redhat.com/ansible/automation-hub/repo/published/dellemc/unity) and use the following command to install the collection anywhere in your system: + + ansible-galaxy collection install dellemc-unity-1.2.1.tar.gz -p + + 2. Set the environment variable: + + export ANSIBLE_COLLECTIONS_PATHS=$ANSIBLE_COLLECTIONS_PATHS: + ## Using Collections - * In order to use any Ansible module, ensure that the importing of proper FQCN(Fully Qualified Collection Name) must be embedded in the playbook. - Below example can be referred - - collections: - - dellemc.unity + 1. In order to use any Ansible module, ensure that the importing of a proper FQCN (Fully Qualified Collection Name) must be embedded in the playbook. Refer to the following example: - - * For generating Ansible documentaion for a specific module, embed the FQCN  before the module name. The below example can be referred. - - ansible-doc dellemc.unity.dellemc_unity_gatherfacts + collections: + - dellemc.unity + + 2. In order to use an installed collection specific to the task use a proper FQCN (Fully Qualified Collection Name). Refer to the following example: + + tasks: + - name: Get Volume details + dellemc.unity.dellemc_unity_volume + + 3. For generating Ansible documentation for a specific module, embed the FQCN before the module name. Refer to the following example: + + ansible-doc dellemc.unity.dellemc_unity_gatherfacts ## Running Ansible Modules -The Ansible server must be configured with Python library for Unity to run the Ansible playbooks. The [Documents]( https://github.com/dell/ansible-unity/tree/1.2.0/docs ) provide information on different Ansible modules along with their functions and syntax. The parameters table in the Product Guide provides information on various parameters which need to be configured before running the modules. +The Ansible server must be configured with Python library for Unity to run the Ansible playbooks. The [Documents]( https://github.com/dell/ansible-unity/tree/1.2.1/docs ) provide information on different Ansible modules along with their functions and syntax. The parameters table in the Product Guide provides information on various parameters which need to be configured before running the modules. ## SSL Certificate Validation diff --git a/dellemc-unity-1.2.0.tar.gz b/dellemc-unity-1.2.0.tar.gz deleted file mode 100644 index 24b4e37..0000000 Binary files a/dellemc-unity-1.2.0.tar.gz and /dev/null differ diff --git a/docs/Product Guide.md b/docs/Product Guide.md index 94f10ae..d8806d6 100644 --- a/docs/Product Guide.md +++ b/docs/Product Guide.md @@ -1,5 +1,5 @@ # Ansible Modules for Dell EMC Unity -## Product Guide 1.2.0 +## Product Guide 1.2.1 © 2021 Dell Inc. or its subsidiaries. All rights reserved. Dell, EMC, and other trademarks are trademarks of Dell Inc. or its subsidiaries. Other trademarks may be trademarks of their respective owners. -------------- @@ -31,14 +31,14 @@ * [File System Module](#file-system-module) * [Synopsis](#synopsis-4) * [Parameters](#parameters-4) - * [Notes](#notes-4) + * [Notes](#notes) * [Examples](#examples-4) * [Return Values](#return-values-4) * [Authors](#authors-4) * [Storage Pool Module](#storage-pool-module) * [Synopsis](#synopsis-5) * [Parameters](#parameters-5) - * [Notes](#notes-5) + * [Notes](#notes-1) * [Examples](#examples-5) * [Return Values](#return-values-5) * [Authors](#authors-5) @@ -57,7 +57,7 @@ * [Filesystem Snapshot Module](#filesystem-snapshot-module) * [Synopsis](#synopsis-8) * [Parameters](#parameters-8) - * [Notes](#notes-8) + * [Notes](#notes-2) * [Examples](#examples-8) * [Return Values](#return-values-8) * [Authors](#authors-8) @@ -70,7 +70,7 @@ * [SMB Share Module](#smb-share-module) * [Synopsis](#synopsis-10) * [Parameters](#parameters-10) - * [Notes](#notes-10) + * [Notes](#notes-3) * [Examples](#examples-10) * [Return Values](#return-values-10) * [Authors](#authors-10) @@ -89,7 +89,7 @@ * [Snapshot Schedule Module](#snapshot-schedule-module) * [Synopsis](#synopsis-13) * [Parameters](#parameters-13) - * [Notes](#notes-13) + * [Notes](#notes-4) * [Examples](#examples-13) * [Return Values](#return-values-13) * [Authors](#authors-13) @@ -136,7 +136,7 @@ Manage NFS export on Unity storage system -
Name of the filesystem for which NFS export will be created.
Either filesystem or snapshot is required for creation of the NFS.
If filesystem name is specified, then nas_server is required to uniquely identify the filesystem
If filesystem parameter is provided, then snapshot cannot be specified. +
Name of the filesystem for which NFS export will be created.
Either filesystem or snapshot is required for creation of the NFS.
If filesystem name is specified, then nas_server is required to uniquely identify the filesystem.
If filesystem parameter is provided, then snapshot cannot be specified. filesystem_id @@ -144,7 +144,7 @@ Manage NFS export on Unity storage system -
ID of the filesystem
This is a unique ID generated by Unity storage system. +
ID of the filesystem.
This is a unique ID generated by Unity storage system. snapshot_name @@ -283,7 +283,7 @@ Manage NFS export on Unity storage system -
Hosts with read-only access to the NFS export.
List of dictionaries. Each dictionary will have any of the keys from host_name, host_id, and ip_address +
Hosts with read-only access to the NFS export.
List of dictionaries. Each dictionary will have any of the keys from host_name, host_id, and ip_address.   @@ -318,7 +318,7 @@ Manage NFS export on Unity storage system -
Hosts with read-only for root user access to the NFS export.
List of dictionaries. Each dictionary will have any of the keys from host_name, host_id, and ip_address +
Hosts with read-only for root user access to the NFS export.
List of dictionaries. Each dictionary will have any of the keys from host_name, host_id, and ip_address.   @@ -463,7 +463,7 @@ Manage NFS export on Unity storage system ### Examples ``` - name: Create nfs export from filesystem - dellemc_unity_nfs: + dellemc.unity.dellemc_unity_nfs: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -474,7 +474,7 @@ Manage NFS export on Unity storage system state: "present" - name: Create nfs export from snapshot - dellemc_unity_nfs: + dellemc.unity.dellemc_unity_nfs: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -485,7 +485,7 @@ Manage NFS export on Unity storage system state: "present" - name: Modify nfs export - dellemc_unity_nfs: + dellemc.unity.dellemc_unity_nfs: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -499,7 +499,7 @@ Manage NFS export on Unity storage system state: "present" - name: Add host in nfs export - dellemc_unity_nfs: + dellemc.unity.dellemc_unity_nfs: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -520,7 +520,7 @@ Manage NFS export on Unity storage system state: "present" - name: Remove host in nfs export - dellemc_unity_nfs: + dellemc.unity.dellemc_unity_nfs: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -541,7 +541,7 @@ Manage NFS export on Unity storage system state: "present" - name: Get nfs details - dellemc_unity_nfs: + dellemc.unity.dellemc_unity_nfs: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -550,7 +550,7 @@ Manage NFS export on Unity storage system state: "present" - name: Delete nfs export by nfs name - dellemc_unity_nfs: + dellemc.unity.dellemc_unity_nfs: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -756,7 +756,7 @@ Manage NFS export on Unity storage system Manage volume on Unity storage system ### Synopsis - Managing volume on Unity storage system includes- Create new volume, Modify volume attributes, Map Volume to host, Unmap volume to host, Display volume details, Delete volume + Managing volume on Unity storage system includes- Create new volume, Modify volume attributes, Map Volume to host, Unmap volume to host, Display volume details, Delete volume. ### Parameters @@ -839,7 +839,7 @@ Manage volume on Unity storage system -
Boolean variable , specifies whether or not to enable compression. Compression is supported only for thin volumes +
Boolean variable , specifies whether or not to enable compression. Compression is supported only for thin volumes. is_thin @@ -847,7 +847,7 @@ Manage volume on Unity storage system True -
Boolean variable , specifies whether or not it's a thin volume. +
Boolean variable , specifies whether or not it is a thin volume. sp @@ -863,7 +863,7 @@ Manage volume on Unity storage system -
IO limit policy associated with this volume. Once it's set, it cannot be removed through ansible module but it can be changed. +
IO limit policy associated with this volume. Once it is set, it cannot be removed through ansible module but it can be changed. host_name @@ -887,7 +887,7 @@ Manage volume on Unity storage system -
Host Lun Unit to be mapped/unmapped with this volume.
It's an optional parameter, hlu can be specified along with host_name or host_id and mapping_state.
If hlu is not specified, unity will choose it automatically. The maximum value supported is 255. +
Host Lun Unit to be mapped/unmapped with this volume.
It is an optional parameter, hlu can be specified along with host_name or host_id and mapping_state.
If hlu is not specified, unity will choose it automatically. The maximum value supported is 255. mapping_state @@ -927,7 +927,7 @@ Manage volume on Unity storage system -
Name of hosts for mapping to a volume +
Name of hosts for mapping to a volume.   @@ -954,7 +954,7 @@ Manage volume on Unity storage system -
Host Lun Unit to be mapped/unmapped with this volume.
It's an optional parameter, hlu can be specified along with host_name or host_id and mapping_state.
If hlu is not specified, unity will choose it automatically. The maximum value supported is 255. +
Host Lun Unit to be mapped/unmapped with this volume.
It is an optional parameter, hlu can be specified along with host_name or host_id and mapping_state.
If hlu is not specified, unity will choose it automatically. The maximum value supported is 255. unispherehost @@ -1002,7 +1002,7 @@ Manage volume on Unity storage system ### Examples ``` - name: Create Volume - dellemc_unity_volume: + dellemc.unity.dellemc_unity_volume: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -1015,7 +1015,7 @@ Manage volume on Unity storage system state: "{{state_present}}" - name: Expand Volume by volume id - dellemc_unity_volume: + dellemc.unity.dellemc_unity_volume: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -1026,7 +1026,7 @@ Manage volume on Unity storage system state: "{{state_present}}" - name: Modify Volume, map host by host_name - dellemc_unity_volume: + dellemc.unity.dellemc_unity_volume: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -1038,7 +1038,7 @@ Manage volume on Unity storage system state: "{{state_present}}" - name: Modify Volume, unmap host mapping by host_name - dellemc_unity_volume: + dellemc.unity.dellemc_unity_volume: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -1049,7 +1049,7 @@ Manage volume on Unity storage system state: "{{state_present}}" - name: Map multiple hosts to a Volume - dellemc_unity_volume: + dellemc.unity.dellemc_unity_volume: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -1064,7 +1064,7 @@ Manage volume on Unity storage system state: "present" - name: Modify Volume attributes - dellemc_unity_volume: + dellemc.unity.dellemc_unity_volume: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -1076,7 +1076,7 @@ Manage volume on Unity storage system state: "{{state_present}}" - name: Delete Volume by vol name - dellemc_unity_volume: + dellemc.unity.dellemc_unity_volume: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -1085,7 +1085,7 @@ Manage volume on Unity storage system state: "{{state_absent}}" - name: Delete Volume by vol id - dellemc_unity_volume: + dellemc.unity.dellemc_unity_volume: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -1107,13 +1107,13 @@ Manage volume on Unity storage system changed bool always - Whether or not the resource has changed + Whether or not the resource has changed. volume_details complex When volume exists - Details of the volume + Details of the volume.   @@ -1380,7 +1380,7 @@ Manage NAS servers on Unity storage system ### Examples ``` - name: Get Details of NAS Server - dellemc_unity_nasserver: + dellemc.unity.dellemc_unity_nasserver: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -1389,7 +1389,7 @@ Manage NAS servers on Unity storage system state: "present" - name: Modify Details of NAS Server - dellemc_unity_nasserver: + dellemc.unity.dellemc_unity_nasserver: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -1517,7 +1517,7 @@ Manage NAS servers on Unity storage system Manage quota tree on the Unity storage system ### Synopsis - Managing Quota tree on the Unity storage system includes Create quota tree, Get quota tree, Modify quota tree and Delete quota tree + Managing Quota tree on the Unity storage system includes Create quota tree, Get quota tree, Modify quota tree and Delete quota tree. ### Parameters @@ -1664,7 +1664,7 @@ Manage quota tree on the Unity storage system ### Examples ``` - name: Get quota tree details by quota tree id - dellemc_unity_tree_quota: + dellemc.unity.dellemc_unity_tree_quota: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -1673,7 +1673,7 @@ Manage quota tree on the Unity storage system state: "present" - name: Get quota tree details by quota tree path - dellemc_unity_tree_quota: + dellemc.unity.dellemc_unity_tree_quota: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -1684,7 +1684,7 @@ Manage quota tree on the Unity storage system state: "present" - name: Create quota tree for a filesystem with filesystem id - dellemc_unity_tree_quota: + dellemc.unity.dellemc_unity_tree_quota: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -1697,7 +1697,7 @@ Manage quota tree on the Unity storage system state: "present" - name: Create quota tree for a filesystem with filesystem name - dellemc_unity_tree_quota: + dellemc.unity.dellemc_unity_tree_quota: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -1711,7 +1711,7 @@ Manage quota tree on the Unity storage system state: "present" - name: Modify quota tree limit usage by quota tree path - dellemc_unity_tree_quota: + dellemc.unity.dellemc_unity_tree_quota: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -1723,7 +1723,7 @@ Manage quota tree on the Unity storage system state: "present" - name: Modify quota tree by quota tree id - dellemc_unity_tree_quota: + dellemc.unity.dellemc_unity_tree_quota: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -1736,7 +1736,7 @@ Manage quota tree on the Unity storage system state: "present" - name: Delete quota tree by quota tree id - dellemc_unity_tree_quota: + dellemc.unity.dellemc_unity_tree_quota: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -1746,7 +1746,7 @@ Manage quota tree on the Unity storage system state: "absent" - name: Delete quota tree by path - dellemc_unity_tree_quota: + dellemc.unity.dellemc_unity_tree_quota: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -1769,7 +1769,7 @@ Manage quota tree on the Unity storage system changed bool always - Whether or not the resource has changed + Whether or not the resource has changed. get_quota_tree_details @@ -1887,7 +1887,7 @@ Manage filesystem on Unity storage system -
The name of the filesystem. Mandatory only for the create operation. All the operations are supported through 'filesystem_name'
It's mutually exclusive with 'filesystem_id'. +
The name of the filesystem. Mandatory only for the create operation. All the operations are supported through 'filesystem_name'.
It is mutually exclusive with 'filesystem_id'. filesystem_id @@ -1895,7 +1895,7 @@ Manage filesystem on Unity storage system -
The id of the filesystem.It's mutually exclusive with 'filesystem_name'
It can be used only for get, modify, or delete operations. +
The id of the filesystem.It is mutually exclusive with 'filesystem_name'.
It can be used only for get, modify, or delete operations. pool_name @@ -1951,7 +1951,7 @@ Manage filesystem on Unity storage system
  • NFS
  • CIFS
  • MULTIPROTOCOL
-
Protocols supported by the file system.
It will be overridden by NAS server configuration if NAS Server is Multiprotocol +
Protocols supported by the file system.
It will be overridden by NAS server configuration if NAS Server is Multiprotocol. description @@ -1967,7 +1967,7 @@ Manage filesystem on Unity storage system -
Advance settings for SMB. It contains optional candidate variables +
Advance settings for SMB. It contains optional candidate variables.   @@ -2020,7 +2020,7 @@ Manage filesystem on Unity storage system -
Boolean variable, specifies whether or not to enable compression. Compression is supported only for thin filesystem +
Boolean variable, specifies whether or not to enable compression. Compression is supported only for thin filesystem. is_thin @@ -2028,7 +2028,7 @@ Manage filesystem on Unity storage system -
Boolean variable, specifies whether or not it's a thin filesystem. +
Boolean variable, specifies whether or not it is a thin filesystem. access_policy @@ -2198,7 +2198,7 @@ Manage filesystem on Unity storage system ### Examples ``` - name: Create FileSystem - dellemc_unity_filesystem: + dellemc.unity.dellemc_unity_filesystem: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -2210,7 +2210,7 @@ Manage filesystem on Unity storage system state: "present" - name: Create FileSystem with quota configuration - dellemc_unity_filesystem: + dellemc.unity.dellemc_unity_filesystem: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -2227,7 +2227,7 @@ Manage filesystem on Unity storage system state: "present" - name: Expand FileSystem size - dellemc_unity_filesystem: + dellemc.unity.dellemc_unity_filesystem: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -2238,7 +2238,7 @@ Manage filesystem on Unity storage system state: "present" - name: Expand FileSystem size - dellemc_unity_filesystem: + dellemc.unity.dellemc_unity_filesystem: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -2249,7 +2249,7 @@ Manage filesystem on Unity storage system state: "present" - name: Modify FileSystem smb_properties - dellemc_unity_filesystem: + dellemc.unity.dellemc_unity_filesystem: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -2263,7 +2263,7 @@ Manage filesystem on Unity storage system state: "present" - name: Modify FileSystem Snap Schedule - dellemc_unity_filesystem: + dellemc.unity.dellemc_unity_filesystem: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -2273,7 +2273,7 @@ Manage filesystem on Unity storage system state: "{{state_present}}" - name: Get details of FileSystem using id - dellemc_unity_filesystem: + dellemc.unity.dellemc_unity_filesystem: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -2282,7 +2282,7 @@ Manage filesystem on Unity storage system state: "present" - name: Delete a FileSystem using id - dellemc_unity_filesystem: + dellemc.unity.dellemc_unity_filesystem: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -2304,7 +2304,7 @@ Manage filesystem on Unity storage system changed bool always - Whether or not the resource has changed + Whether or not the resource has changed. filesystem_snapshot_details @@ -2437,9 +2437,9 @@ Manage filesystem on Unity storage system Manage storage pool on Unity ### Synopsis - Managing storage pool on Unity storage system contains the following operations - Get details of storage pool - Modify storage pool + Managing storage pool on Unity storage system contains the following operations. + Get details of storage pool. + Modify storage pool. ### Parameters @@ -2556,7 +2556,7 @@ Manage storage pool on Unity ### Examples ``` - name: Get Storage pool details using pool_name - dellemc_unity_storagepool: + dellemc.unity.dellemc_unity_storagepool: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -2565,7 +2565,7 @@ Manage storage pool on Unity state: "present" - name: Get Storage pool details using pool_id - dellemc_unity_storagepool: + dellemc.unity.dellemc_unity_storagepool: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -2574,7 +2574,7 @@ Manage storage pool on Unity state: "present" - name: Modify Storage pool attributes using pool_name - dellemc_unity_storagepool: + dellemc.unity.dellemc_unity_storagepool: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -2587,7 +2587,7 @@ Manage storage pool on Unity state: "present" - name: Modify Storage pool attributes using pool_id - dellemc_unity_storagepool: + dellemc.unity.dellemc_unity_storagepool: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -2768,8 +2768,8 @@ Gathering information about DellEMC Unity ### Examples ``` - - name: Get detailed list of Unity entities. - dellemc_unity_gatherfacts: + - name: Get detailed list of Unity entities + dellemc.unity.dellemc_unity_gatherfacts: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -2790,15 +2790,15 @@ Gathering information about DellEMC Unity - user_quota - tree_quota - - name: Get information of Unity array. - dellemc_unity_gatherfacts: + - name: Get information of Unity array + dellemc.unity.dellemc_unity_gatherfacts: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" verifycert: "{{verifycert}}" - - name: Get list of hosts on Unity array. - dellemc_unity_gatherfacts: + - name: Get list of hosts on Unity array + dellemc.unity.dellemc_unity_gatherfacts: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -2806,8 +2806,8 @@ Gathering information about DellEMC Unity gather_subset: - host - - name: Get list of FC initiators on Unity array. - dellemc_unity_gatherfacts: + - name: Get list of FC initiators on Unity array + dellemc.unity.dellemc_unity_gatherfacts: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -2815,8 +2815,8 @@ Gathering information about DellEMC Unity gather_subset: - fc_initiator - - name: Get list of ISCSI initiators on Unity array. - dellemc_unity_gatherfacts: + - name: Get list of ISCSI initiators on Unity array + dellemc.unity.dellemc_unity_gatherfacts: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -2824,8 +2824,8 @@ Gathering information about DellEMC Unity gather_subset: - iscsi_initiator - - name: Get list of consistency groups on Unity array. - dellemc_unity_gatherfacts: + - name: Get list of consistency groups on Unity array + dellemc.unity.dellemc_unity_gatherfacts: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -2833,8 +2833,8 @@ Gathering information about DellEMC Unity gather_subset: - cg - - name: Get list of storage pools on Unity array. - dellemc_unity_gatherfacts: + - name: Get list of storage pools on Unity array + dellemc.unity.dellemc_unity_gatherfacts: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -2842,8 +2842,8 @@ Gathering information about DellEMC Unity gather_subset: - storage_pool - - name: Get list of volumes on Unity array. - dellemc_unity_gatherfacts: + - name: Get list of volumes on Unity array + dellemc.unity.dellemc_unity_gatherfacts: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -2851,8 +2851,8 @@ Gathering information about DellEMC Unity gather_subset: - vol - - name: Get list of snapshot schedules on Unity array. - dellemc_unity_gatherfacts: + - name: Get list of snapshot schedules on Unity array + dellemc.unity.dellemc_unity_gatherfacts: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -2860,8 +2860,8 @@ Gathering information about DellEMC Unity gather_subset: - snapshot_schedule - - name: Get list of NAS Servers on Unity array. - dellemc_unity_gatherfacts: + - name: Get list of NAS Servers on Unity array + dellemc.unity.dellemc_unity_gatherfacts: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -2869,8 +2869,8 @@ Gathering information about DellEMC Unity gather_subset: - nas_server - - name: Get list of File Systems on Unity array. - dellemc_unity_gatherfacts: + - name: Get list of File Systems on Unity array + dellemc.unity.dellemc_unity_gatherfacts: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -2878,8 +2878,8 @@ Gathering information about DellEMC Unity gather_subset: - file_system - - name: Get list of Snapshots on Unity array. - dellemc_unity_gatherfacts: + - name: Get list of Snapshots on Unity array + dellemc.unity.dellemc_unity_gatherfacts: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -2887,8 +2887,8 @@ Gathering information about DellEMC Unity gather_subset: - snapshot - - name: Get list of NFS exports on Unity array. - dellemc_unity_gatherfacts: + - name: Get list of NFS exports on Unity array + dellemc.unity.dellemc_unity_gatherfacts: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -2896,8 +2896,8 @@ Gathering information about DellEMC Unity gather_subset: - nfs_export - - name: Get list of SMB shares on Unity array. - dellemc_unity_gatherfacts: + - name: Get list of SMB shares on Unity array + dellemc.unity.dellemc_unity_gatherfacts: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -2905,8 +2905,8 @@ Gathering information about DellEMC Unity gather_subset: - smb_share - - name: Get list of user quotas on Unity array. - dellemc_unity_gatherfacts: + - name: Get list of user quotas on Unity array + dellemc.unity.dellemc_unity_gatherfacts: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -2914,8 +2914,8 @@ Gathering information about DellEMC Unity gather_subset: - user_quota - - name: Get list of quota trees on Unity array. - dellemc_unity_gatherfacts: + - name: Get list of quota trees on Unity array + dellemc.unity.dellemc_unity_gatherfacts: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -3445,7 +3445,7 @@ Manage user quota on the Unity storage system ### Examples ``` - name: Get user quota details by user quota id - dellemc_unity_user_quota: + dellemc.unity.dellemc_unity_user_quota: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -3454,7 +3454,7 @@ Manage user quota on the Unity storage system state: "present" - name: Get user quota details by user quota uid/user name - dellemc_unity_user_quota: + dellemc.unity.dellemc_unity_user_quota: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -3465,7 +3465,7 @@ Manage user quota on the Unity storage system state: "present" - name: Create user quota for a filesystem with filesystem id - dellemc_unity_user_quota: + dellemc.unity.dellemc_unity_user_quota: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -3474,12 +3474,11 @@ Manage user quota on the Unity storage system hard_limit: 6 cap_unit: "TB" soft_limit: 5 - user_type: "UID" uid: "111" state: "present" - name: Create user quota for a filesystem with filesystem name - dellemc_unity_user_quota: + dellemc.unity.dellemc_unity_user_quota: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -3489,12 +3488,11 @@ Manage user quota on the Unity storage system hard_limit: 6 cap_unit: "TB" soft_limit: 5 - user_type: "UID" uid: "111" state: "present" - name: Modify user quota limit usage by user quota id - dellemc_unity_user_quota: + dellemc.unity.dellemc_unity_user_quota: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -3506,7 +3504,7 @@ Manage user quota on the Unity storage system state: "present" - name: Modify user quota by filesystem id and user quota uid/user_name - dellemc_unity_user_quota: + dellemc.unity.dellemc_unity_user_quota: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -3521,7 +3519,7 @@ Manage user quota on the Unity storage system state: "present" - name: Delete user quota - dellemc_unity_user_quota: + dellemc.unity.dellemc_unity_user_quota: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -3532,7 +3530,7 @@ Manage user quota on the Unity storage system state: "absent" - name: Create user quota of a quota tree - dellemc_unity_user_quota: + dellemc.unity.dellemc_unity_user_quota: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -3546,7 +3544,7 @@ Manage user quota on the Unity storage system state: "present" - name: Create user quota of a quota tree by quota tree path - dellemc_unity_user_quota: + dellemc.unity.dellemc_unity_user_quota: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -3560,7 +3558,7 @@ Manage user quota on the Unity storage system state: "present" - name: Modify user quota of a quota tree - dellemc_unity_user_quota: + dellemc.unity.dellemc_unity_user_quota: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -3574,7 +3572,7 @@ Manage user quota on the Unity storage system state: "present" - name: Modify user quota of a quota tree by quota tree path - dellemc_unity_user_quota: + dellemc.unity.dellemc_unity_user_quota: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -3589,7 +3587,7 @@ Manage user quota on the Unity storage system state: "present" - name: Delete user quota of a quota tree by quota tree path - dellemc_unity_user_quota: + dellemc.unity.dellemc_unity_user_quota: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -3601,7 +3599,7 @@ Manage user quota on the Unity storage system state: "absent" - name: Delete user quota of a quota tree by quota tree id - dellemc_unity_user_quota: + dellemc.unity.dellemc_unity_user_quota: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -3625,7 +3623,7 @@ Manage user quota on the Unity storage system changed bool always - Whether or not the resource has changed + Whether or not the resource has changed. get_user_quota_details @@ -3952,7 +3950,7 @@ Manage filesystem snapshot on the Unity storage system ### Examples ``` - name: Create Filesystem Snapshot - dellemc_unity_filesystem_snapshot: + dellemc.unity.dellemc_unity_filesystem_snapshot: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -3965,8 +3963,8 @@ Manage filesystem snapshot on the Unity storage system fs_access_type: "Protocol" state: "present" - - name: Create Filesystem Snapshot with expiry time. - dellemc_unity_filesystem_snapshot: + - name: Create Filesystem Snapshot with expiry time + dellemc.unity.dellemc_unity_filesystem_snapshot: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -3980,7 +3978,7 @@ Manage filesystem snapshot on the Unity storage system state: "present" - name: Get Filesystem Snapshot Details using Name - dellemc_unity_filesystem_snapshot: + dellemc.unity.dellemc_unity_filesystem_snapshot: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -3989,7 +3987,7 @@ Manage filesystem snapshot on the Unity storage system state: "present" - name: Get Filesystem Snapshot Details using ID - dellemc_unity_filesystem_snapshot: + dellemc.unity.dellemc_unity_filesystem_snapshot: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -3998,7 +3996,7 @@ Manage filesystem snapshot on the Unity storage system state: "present" - name: Update Filesystem Snapshot attributes - dellemc_unity_filesystem_snapshot: + dellemc.unity.dellemc_unity_filesystem_snapshot: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -4010,7 +4008,7 @@ Manage filesystem snapshot on the Unity storage system state: "present" - name: Update Filesystem Snapshot attributes using ID - dellemc_unity_filesystem_snapshot: + dellemc.unity.dellemc_unity_filesystem_snapshot: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -4020,7 +4018,7 @@ Manage filesystem snapshot on the Unity storage system state: "present" - name: Delete Filesystem Snapshot using Name - dellemc_unity_filesystem_snapshot: + dellemc.unity.dellemc_unity_filesystem_snapshot: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -4029,7 +4027,7 @@ Manage filesystem snapshot on the Unity storage system state: "absent" - name: Delete Filesystem Snapshot using ID - dellemc_unity_filesystem_snapshot: + dellemc.unity.dellemc_unity_filesystem_snapshot: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -4051,7 +4049,7 @@ Manage filesystem snapshot on the Unity storage system changed bool always - Whether or not the resource has changed + Whether or not the resource has changed. filesystem_snapshot_details @@ -4179,7 +4177,7 @@ Manage filesystem snapshot on the Unity storage system -------------------------------- # Snapshot Module -Manage snapshots on the Unity storage system. +Manage snapshots on the Unity storage system ### Synopsis Managing snapshots on the Unity storage system includes create snapshot, delete snapshot, update snapshot, get snapshot, map host and unmap host. @@ -4281,7 +4279,7 @@ Manage snapshots on the Unity storage system. -
The id of the host.
Either host_name or host_id is required to map or unmap a snapshot from a host
Snapshot can be attached to multiple hosts. +
The id of the host.
Either host_name or host_id is required to map or unmap a snapshot from a host.
Snapshot can be attached to multiple hosts. host_state @@ -4337,7 +4335,7 @@ Manage snapshots on the Unity storage system. ### Examples ``` - name: Create a Snapshot for a CG - dellemc_unity_snapshot: + dellemc.unity.dellemc_unity_snapshot: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -4349,8 +4347,8 @@ Manage snapshots on the Unity storage system. auto_delete: False state: "present" - - name: Create a Snapshot for a volume with Host attached. - dellemc_unity_snapshot: + - name: Create a Snapshot for a volume with Host attached + dellemc.unity.dellemc_unity_snapshot: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -4365,7 +4363,7 @@ Manage snapshots on the Unity storage system. state: "present" - name: Unmap a host for a Snapshot - dellemc_unity_snapshot: + dellemc.unity.dellemc_unity_snapshot: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -4377,7 +4375,7 @@ Manage snapshots on the Unity storage system. state: "present" - name: Map snapshot to a host - dellemc_unity_snapshot: + dellemc.unity.dellemc_unity_snapshot: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -4389,7 +4387,7 @@ Manage snapshots on the Unity storage system. state: "present" - name: Update attributes of a Snapshot for a volume - dellemc_unity_snapshot: + dellemc.unity.dellemc_unity_snapshot: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -4401,8 +4399,8 @@ Manage snapshots on the Unity storage system. host_state: "unmapped" state: "present" - - name: Delete Snapshot of CG. - dellemc_unity_snapshot: + - name: Delete Snapshot of CG + dellemc.unity.dellemc_unity_snapshot: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -4424,7 +4422,7 @@ Manage snapshots on the Unity storage system. changed bool always - Whether or not the resource has changed + Whether or not the resource has changed. snapshot_details @@ -4489,7 +4487,7 @@ Manage snapshots on the Unity storage system. -------------------------------- # SMB Share Module -Manage SMB shares on Unity storage system. +Manage SMB shares on Unity storage system ### Synopsis Managing SMB Shares on Unity storage system includes create, get, modify, and delete the smb shares. @@ -4689,7 +4687,7 @@ Manage SMB shares on Unity storage system. ### Examples ``` - name: Create SMB share for a filesystem - dellemc_unity_smbshare: + dellemc.unity.dellemc_unity_smbshare: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -4707,7 +4705,7 @@ Manage SMB shares on Unity storage system. umask: "777" state: "present" - name: Modify Attributes of SMB share for a filesystem - dellemc_unity_smbshare: + dellemc.unity.dellemc_unity_smbshare: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -4723,7 +4721,7 @@ Manage SMB shares on Unity storage system. umask: "022" state: "present" - name: Create SMB share for a snapshot - dellemc_unity_smbshare: + dellemc.unity.dellemc_unity_smbshare: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -4740,7 +4738,7 @@ Manage SMB shares on Unity storage system. umask: "777" state: "present" - name: Modify Attributes of SMB share for a snapshot - dellemc_unity_smbshare: + dellemc.unity.dellemc_unity_smbshare: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -4756,7 +4754,7 @@ Manage SMB shares on Unity storage system. umask: "022" state: "present" - name: Get details of SMB share - dellemc_unity_smbshare: + dellemc.unity.dellemc_unity_smbshare: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -4764,7 +4762,7 @@ Manage SMB shares on Unity storage system. share_id: "{{smb_share_id}}" state: "present" - name: Delete SMB share - dellemc_unity_smbshare: + dellemc.unity.dellemc_unity_smbshare: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -4786,7 +4784,7 @@ Manage SMB shares on Unity storage system. changed bool always - Whether or not the resource has changed + Whether or not the resource has changed. smb_share_details @@ -4900,7 +4898,7 @@ Manage SMB shares on Unity storage system. -------------------------------- # Host Module -Manage Host operations on Unity. +Manage Host operations on Unity ### Synopsis The Host module contains the following operations Creation of a Host. Addition of initiators to Host. Removal of initiators from Host. Modification of host attributes. Get details of a Host. Deletion of a Host. @@ -5025,8 +5023,8 @@ Manage Host operations on Unity. ### Examples ``` -- name: Create empty Host. - dellemc_unity_host: +- name: Create empty Host + dellemc.unity.dellemc_unity_host: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -5036,8 +5034,8 @@ Manage Host operations on Unity. description: "ansible-test-host" state: "present" -- name: Create Host with Initiators. - dellemc_unity_host: +- name: Create Host with Initiators + dellemc.unity.dellemc_unity_host: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -5051,8 +5049,8 @@ Manage Host operations on Unity. initiator_state: "present-in-host" state: "present" -- name: Modify Host using host_id. - dellemc_unity_host: +- name: Modify Host using host_id + dellemc.unity.dellemc_unity_host: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -5063,8 +5061,8 @@ Manage Host operations on Unity. description: "Ansible tesing purpose" state: "present" -- name: Add Initiators to Host. - dellemc_unity_host: +- name: Add Initiators to Host + dellemc.unity.dellemc_unity_host: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -5075,8 +5073,8 @@ Manage Host operations on Unity. initiator_state: "present-in-host" state: "present" -- name: Get Host details using host_name. - dellemc_unity_host: +- name: Get Host details using host_name + dellemc.unity.dellemc_unity_host: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -5084,8 +5082,8 @@ Manage Host operations on Unity. host_name: "ansible-test-host-2" state: "present" -- name: Get Host details using host_id. - dellemc_unity_host: +- name: Get Host details using host_id + dellemc.unity.dellemc_unity_host: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -5093,8 +5091,8 @@ Manage Host operations on Unity. host_id: "Host_253" state: "present" -- name: Delete Host. - dellemc_unity_host: +- name: Delete Host + dellemc.unity.dellemc_unity_host: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -5383,7 +5381,7 @@ Manage consistency groups on Unity storage system ### Examples ``` - name: Create consistency group - dellemc_unity_consistencygroup: + dellemc.unity.dellemc_unity_consistencygroup: unispherehost: "{{unispherehost}}" verifycert: "{{verifycert}}" username: "{{username}}" @@ -5394,7 +5392,7 @@ Manage consistency groups on Unity storage system state: "present" - name: Get details of consistency group using id - dellemc_unity_consistencygroup: + dellemc.unity.dellemc_unity_consistencygroup: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -5403,7 +5401,7 @@ Manage consistency groups on Unity storage system state: "present" - name: Add volumes to consistency group - dellemc_unity_consistencygroup: + dellemc.unity.dellemc_unity_consistencygroup: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -5416,7 +5414,7 @@ Manage consistency groups on Unity storage system state: "present" - name: Rename consistency group - dellemc_unity_consistencygroup: + dellemc.unity.dellemc_unity_consistencygroup: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -5426,7 +5424,7 @@ Manage consistency groups on Unity storage system state: "present" - name: Modify consistency group details - dellemc_unity_consistencygroup: + dellemc.unity.dellemc_unity_consistencygroup: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -5437,7 +5435,7 @@ Manage consistency groups on Unity storage system state: "present" - name: Map hosts to a consistency group - dellemc_unity_consistencygroup: + dellemc.unity.dellemc_unity_consistencygroup: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -5450,7 +5448,7 @@ Manage consistency groups on Unity storage system state: "present" - name: Unmap hosts from a consistency group - dellemc_unity_consistencygroup: + dellemc.unity.dellemc_unity_consistencygroup: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -5463,7 +5461,7 @@ Manage consistency groups on Unity storage system state: "present" - name: Remove volumes from consistency group - dellemc_unity_consistencygroup: + dellemc.unity.dellemc_unity_consistencygroup: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -5476,7 +5474,7 @@ Manage consistency groups on Unity storage system state: "present" - name: Delete consistency group - dellemc_unity_consistencygroup: + dellemc.unity.dellemc_unity_consistencygroup: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -5498,13 +5496,13 @@ Manage consistency groups on Unity storage system changed bool always - Whether or not the resource has changed + Whether or not the resource has changed. consistency_group_details complex When consistency group exists - Details of the consistency group + Details of the consistency group.   @@ -5743,7 +5741,7 @@ Manage snapshot schedules on Unity storage system -
the hour when the snapshot will be taken.
Applicable for 'every_n_days', 'every_week', 'every_month' rule types.
For create operation, if 'hour' parameter is not specified, value will be taken as 0.
Value should be [0, 23]. +
The hour when the snapshot will be taken.
Applicable for 'every_n_days', 'every_week', 'every_month' rule types.
For create operation, if 'hour' parameter is not specified, value will be taken as 0.
Value should be [0, 23]. minute @@ -5828,14 +5826,14 @@ Manage snapshot schedules on Unity storage system ### Notes -* Snapshot schedule created via Ansible will have only one rule. +* Snapshot schedule created through Ansible will have only one rule. * Modification of rule type is not allowed. Within the same type, other parameters can be modified. * If an existing snapshot schedule has more than 1 rule in it, only get and delete operation is allowed. ### Examples ``` - name: Create snapshot schedule (Rule Type - every_n_hours) - dellemc_unity_snapshotschedule: + dellemc.unity.dellemc_unity_snapshotschedule: unispherehost: "{{unispherehost}}" verifycert: "{{verifycert}}" username: "{{username}}" @@ -5847,7 +5845,7 @@ Manage snapshot schedules on Unity storage system state: "{{state_present}}" - name: Create snapshot schedule (Rule Type - every_day) - dellemc_unity_snapshotschedule: + dellemc.unity.dellemc_unity_snapshotschedule: unispherehost: "{{unispherehost}}" verifycert: "{{verifycert}}" username: "{{username}}" @@ -5861,7 +5859,7 @@ Manage snapshot schedules on Unity storage system state: "{{state_present}}" - name: Create snapshot schedule (Rule Type - every_n_days) - dellemc_unity_snapshotschedule: + dellemc.unity.dellemc_unity_snapshotschedule: unispherehost: "{{unispherehost}}" verifycert: "{{verifycert}}" username: "{{username}}" @@ -5874,7 +5872,7 @@ Manage snapshot schedules on Unity storage system state: "{{state_present}}" - name: Create snapshot schedule (Rule Type - every_week) - dellemc_unity_snapshotschedule: + dellemc.unity.dellemc_unity_snapshotschedule: unispherehost: "{{unispherehost}}" verifycert: "{{verifycert}}" username: "{{username}}" @@ -5890,7 +5888,7 @@ Manage snapshot schedules on Unity storage system state: "{{state_present}}" - name: Create snapshot schedule (Rule Type - every_month) - dellemc_unity_snapshotschedule: + dellemc.unity.dellemc_unity_snapshotschedule: unispherehost: "{{unispherehost}}" verifycert: "{{verifycert}}" username: "{{username}}" @@ -5902,7 +5900,7 @@ Manage snapshot schedules on Unity storage system state: "{{state_present}}" - name: Get snapshot schedule details using name - dellemc_unity_snapshotschedule: + dellemc.unity.dellemc_unity_snapshotschedule: unispherehost: "{{unispherehost}}" verifycert: "{{verifycert}}" username: "{{username}}" @@ -5911,7 +5909,7 @@ Manage snapshot schedules on Unity storage system state: "{{state_present}}" - name: Get snapshot schedule details using id - dellemc_unity_snapshotschedule: + dellemc.unity.dellemc_unity_snapshotschedule: unispherehost: "{{unispherehost}}" verifycert: "{{verifycert}}" username: "{{username}}" @@ -5920,7 +5918,7 @@ Manage snapshot schedules on Unity storage system state: "{{state_present}}" - name: Modify snapshot schedule details id - dellemc_unity_snapshotschedule: + dellemc.unity.dellemc_unity_snapshotschedule: unispherehost: "{{unispherehost}}" verifycert: "{{verifycert}}" username: "{{username}}" @@ -5931,7 +5929,7 @@ Manage snapshot schedules on Unity storage system state: "{{state_present}}" - name: Modify snapshot schedule using name - dellemc_unity_snapshotschedule: + dellemc.unity.dellemc_unity_snapshotschedule: unispherehost: "{{unispherehost}}" verifycert: "{{verifycert}}" username: "{{username}}" @@ -5943,7 +5941,7 @@ Manage snapshot schedules on Unity storage system state: "{{state_present}}" - name: Delete snapshot schedule using id - dellemc_unity_snapshotschedule: + dellemc.unity.dellemc_unity_snapshotschedule: unispherehost: "{{unispherehost}}" verifycert: "{{verifycert}}" username: "{{username}}" @@ -5952,7 +5950,7 @@ Manage snapshot schedules on Unity storage system state: "{{state_absent}}" - name: Delete snapshot schedule using name - dellemc_unity_snapshotschedule: + dellemc.unity.dellemc_unity_snapshotschedule: unispherehost: "{{unispherehost}}" verifycert: "{{verifycert}}" username: "{{username}}" diff --git a/docs/Release Notes.md b/docs/Release Notes.md index 14f7d01..a1f1cdb 100644 --- a/docs/Release Notes.md +++ b/docs/Release Notes.md @@ -1,6 +1,6 @@ **Ansible Modules for Dell EMC Unity** ========================================= -### Release Notes 1.2.0 +### Release Notes 1.2.1 > © 2021 Dell Inc. or its subsidiaries. All rights reserved. Dell, > EMC, and other trademarks are trademarks of Dell Inc. or its @@ -28,7 +28,7 @@ Table 1. Revision history | Revision | Date | Description | |----------|-----------|-----------------------------------------------------------| -| 01 | June 2021 | Current release of Ansible Modules for Dell EMC Unity 1.2.0 | +| 01 | Sept 2021 | Current release of Ansible Modules for Dell EMC Unity 1.2.1 | Product Description ------------------- @@ -36,42 +36,13 @@ The Ansible modules for Dell EMC Unity are used to automate and orchestrate the New features & enhancements --------------------------- -This release supports the following features - +This release has the following changes - -- Application Tagging: - - A new HTTP header (Application-Type) is added in Unity REST API in Goshawk release which is used to set REST client name and its version and this information is recorded in Unity logs - - Ansible modules support application tagging which is used to identify the REST application that makes the request to Unisphere - - The value of application type parameter from Ansible module is set to Ansible/1.2.0 - -- User quota module supports the following functionalities: - - Create User quota for a Filesystem/Quota tree - - Get User quota details - - Modify attributes of User quota - - Delete User quota - -- Quota tree module supports the following functionalities: - - Create Quota tree for a Filesystem - - Get Quota tree details - - Modify attributes of Quota tree - - Delete Quota tree - -- Consistency group module has the following enhancements: - - Map hosts to a new or an existing Consistency group - - Unmap hosts from a Consistency group - -- Filesystem module has the following enhancements: - - Set the attributes of Quota config while Filesystem creation - - Associate an existing snapshot schedule to existing or new Filesystem - - Remove snapshot schedule from a Filesystem - -- Volume module has the following enhancements: - - Map multiple hosts to a new or existing volume - - Unmap multiple hosts from a volume - -- Gather Facts Module has the following enhancements: - - List of User quota - - List of Quota tree +- Fixed typo in galaxy.yml +- Updated few samples in modules +- Added dual licensing +- Documentation updates Known issues ------------ @@ -94,7 +65,7 @@ for Unity GitHub](https://github.com/dell/ansible-unity/) page. Documentation ------------- -The documentation is available on [Ansible Modules for Unity GitHub](https://github.com/dell/ansible-unity/tree/1.2.0/docs) +The documentation is available on [Ansible Modules for Unity GitHub](https://github.com/dell/ansible-unity/tree/1.2.1/docs) page. It includes the following: - README - Release Notes (this document) diff --git a/galaxy.yml b/galaxy.yml index 09a3618..e80c6df 100644 --- a/galaxy.yml +++ b/galaxy.yml @@ -8,7 +8,7 @@ namespace: dellemc name: unity # The version of the collection. Must be compatible with semantic versioning -version: 1.2.0 +version: 1.2.1 # The path to the Markdown (.md) readme file. This path is relative to the root of the collection readme: README.md @@ -31,10 +31,8 @@ description: Ansible modules for Dell EMC Unity # Either a single license or a list of licenses for content inside of a collection. Ansible Galaxy currently only # accepts L(SPDX,https://spdx.org/licenses/) licenses. This key is mutually exclusive with 'license_file' license: - -# The path to the license file for the collection. This path is relative to the root of the collection. This key is -# mutually exclusive with 'license' -license_file: 'LICENSE' + - GPL-3.0-or-later + - Apache-2.0 # A list of tags you want to associate with the collection for indexing/searching. A tag name has the same character # requirements as 'namespace' and 'name' @@ -47,13 +45,13 @@ tags: [storage] dependencies: {} # The URL of the originating SCM repository -repository: https://github.com/dell/ansible-unity/tree/1.2.0. +repository: https://github.com/dell/ansible-unity/tree/1.2.1 # The URL to any online docs -documentation: https://github.com/dell/ansible-unity/tree/1.2.0/docs +documentation: https://github.com/dell/ansible-unity/tree/1.2.1/docs # The URL to the homepage of the collection/project -homepage: https://github.com/dell/ansible-unity/tree/1.2.0 +homepage: https://github.com/dell/ansible-unity/tree/1.2.1 # The URL to the collection issue tracker issues: https://www.dell.com/community/Automation/bd-p/Automation diff --git a/plugins/module_utils/storage/dell/dellemc_ansible_unity_utils.py b/plugins/module_utils/storage/dell/dellemc_ansible_unity_utils.py index ac8a5d0..9b2c56a 100644 --- a/plugins/module_utils/storage/dell/dellemc_ansible_unity_utils.py +++ b/plugins/module_utils/storage/dell/dellemc_ansible_unity_utils.py @@ -1,4 +1,7 @@ # Copyright: (c) 2020, DellEMC + +# Apache License version 2.0 (see MODULE-LICENSE or http://www.apache.org/licenses/LICENSE-2.0.txt) + from __future__ import absolute_import, division, print_function __metaclass__ = type @@ -98,12 +101,12 @@ def get_unity_sdk(): def get_unity_management_host_parameters(): return dict( - unispherehost=dict(type='str', required=True), + unispherehost=dict(type='str', required=True, no_log=True), username=dict(type='str', required=True), password=dict(type='str', required=True, no_log=True), verifycert=dict(choices=[True, False], type='bool', required=False, default=True), - port=dict(type='int', required=False, default=443) + port=dict(type='int', required=False, default=443, no_log=True) ) diff --git a/plugins/modules/dellemc_unity_consistencygroup.py b/plugins/modules/dellemc_unity_consistencygroup.py index 1f6aeb1..58bff39 100644 --- a/plugins/modules/dellemc_unity_consistencygroup.py +++ b/plugins/modules/dellemc_unity_consistencygroup.py @@ -1,6 +1,8 @@ #!/usr/bin/python # Copyright: (c) 2020, DellEMC +# Apache License version 2.0 (see MODULE-LICENSE or http://www.apache.org/licenses/LICENSE-2.0.txt) + """Ansible module for managing consistency group on Unity""" from __future__ import absolute_import, division, print_function @@ -129,7 +131,7 @@ EXAMPLES = r""" - name: Create consistency group - dellemc_unity_consistencygroup: + dellemc.unity.dellemc_unity_consistencygroup: unispherehost: "{{unispherehost}}" verifycert: "{{verifycert}}" username: "{{username}}" @@ -140,7 +142,7 @@ state: "present" - name: Get details of consistency group using id - dellemc_unity_consistencygroup: + dellemc.unity.dellemc_unity_consistencygroup: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -149,7 +151,7 @@ state: "present" - name: Add volumes to consistency group - dellemc_unity_consistencygroup: + dellemc.unity.dellemc_unity_consistencygroup: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -162,7 +164,7 @@ state: "present" - name: Rename consistency group - dellemc_unity_consistencygroup: + dellemc.unity.dellemc_unity_consistencygroup: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -172,7 +174,7 @@ state: "present" - name: Modify consistency group details - dellemc_unity_consistencygroup: + dellemc.unity.dellemc_unity_consistencygroup: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -183,7 +185,7 @@ state: "present" - name: Map hosts to a consistency group - dellemc_unity_consistencygroup: + dellemc.unity.dellemc_unity_consistencygroup: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -196,7 +198,7 @@ state: "present" - name: Unmap hosts from a consistency group - dellemc_unity_consistencygroup: + dellemc.unity.dellemc_unity_consistencygroup: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -209,7 +211,7 @@ state: "present" - name: Remove volumes from consistency group - dellemc_unity_consistencygroup: + dellemc.unity.dellemc_unity_consistencygroup: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -222,7 +224,7 @@ state: "present" - name: Delete consistency group - dellemc_unity_consistencygroup: + dellemc.unity.dellemc_unity_consistencygroup: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -233,12 +235,13 @@ RETURN = r''' changed: - description: Whether or not the resource has changed + description: Whether or not the resource has changed. returned: always type: bool + sample: true consistency_group_details: - description: Details of the consistency group + description: Details of the consistency group. returned: When consistency group exists type: complex contains: @@ -340,7 +343,7 @@ UNITY_SDK_VERSION_CHECK = utils.storops_version_check() -application_type = "Ansible/1.2.0" +application_type = "Ansible/1.2.1" class UnityConsistencyGroup(object): diff --git a/plugins/modules/dellemc_unity_filesystem.py b/plugins/modules/dellemc_unity_filesystem.py index 308f04d..06f2a16 100644 --- a/plugins/modules/dellemc_unity_filesystem.py +++ b/plugins/modules/dellemc_unity_filesystem.py @@ -1,6 +1,8 @@ #!/usr/bin/python # Copyright: (c) 2020, DellEMC +# Apache License version 2.0 (see MODULE-LICENSE or http://www.apache.org/licenses/LICENSE-2.0.txt) + """Ansible module for managing FileSystem on Unity""" from __future__ import absolute_import, division, print_function @@ -40,13 +42,13 @@ filesystem_name: description: - The name of the filesystem. Mandatory only for the create operation. - All the operations are supported through 'filesystem_name' - - It's mutually exclusive with 'filesystem_id'. + All the operations are supported through 'filesystem_name'. + - It is mutually exclusive with 'filesystem_id'. required: False type: str filesystem_id: description: - - The id of the filesystem.It's mutually exclusive with 'filesystem_name' + - The id of the filesystem.It is mutually exclusive with 'filesystem_name'. - It can be used only for get, modify, or delete operations. required: False type: str @@ -82,7 +84,7 @@ supported_protocols: description: - Protocols supported by the file system. - - It will be overridden by NAS server configuration if NAS Server is Multiprotocol + - It will be overridden by NAS server configuration if NAS Server is Multiprotocol. type: str choices: ['NFS', 'CIFS', 'MULTIPROTOCOL'] description: @@ -92,7 +94,7 @@ type: str smb_properties: description: - - Advance settings for SMB. It contains optional candidate variables + - Advance settings for SMB. It contains optional candidate variables. type: dict suboptions: is_smb_sync_writes_enabled: @@ -124,11 +126,11 @@ data_reduction: description: - Boolean variable, specifies whether or not to enable compression. - Compression is supported only for thin filesystem + Compression is supported only for thin filesystem. type: bool is_thin: description: - - Boolean variable, specifies whether or not it's a thin filesystem. + - Boolean variable, specifies whether or not it is a thin filesystem. type: bool access_policy: description: @@ -230,7 +232,7 @@ EXAMPLES = r""" - name: Create FileSystem - dellemc_unity_filesystem: + dellemc.unity.dellemc_unity_filesystem: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -242,7 +244,7 @@ state: "present" - name: Create FileSystem with quota configuration - dellemc_unity_filesystem: + dellemc.unity.dellemc_unity_filesystem: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -259,7 +261,7 @@ state: "present" - name: Expand FileSystem size - dellemc_unity_filesystem: + dellemc.unity.dellemc_unity_filesystem: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -270,7 +272,7 @@ state: "present" - name: Expand FileSystem size - dellemc_unity_filesystem: + dellemc.unity.dellemc_unity_filesystem: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -281,7 +283,7 @@ state: "present" - name: Modify FileSystem smb_properties - dellemc_unity_filesystem: + dellemc.unity.dellemc_unity_filesystem: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -295,7 +297,7 @@ state: "present" - name: Modify FileSystem Snap Schedule - dellemc_unity_filesystem: + dellemc.unity.dellemc_unity_filesystem: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -305,7 +307,7 @@ state: "{{state_present}}" - name: Get details of FileSystem using id - dellemc_unity_filesystem: + dellemc.unity.dellemc_unity_filesystem: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -314,7 +316,7 @@ state: "present" - name: Delete a FileSystem using id - dellemc_unity_filesystem: + dellemc.unity.dellemc_unity_filesystem: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -325,33 +327,33 @@ RETURN = r''' changed: - description: Whether or not the resource has changed + description: Whether or not the resource has changed. returned: always type: bool filesystem_details: - description: Details of the filesystem + description: Details of the filesystem. returned: When filesystem exists type: complex contains: id: - description: The system generated ID given to the filesystem + description: The system generated ID given to the filesystem. type: str name: - description: Name of the filesystem + description: Name of the filesystem. type: str description: - description: Description about the filesystem + description: Description about the filesystem. type: str is_data_reduction_enabled: description: Whether or not compression enabled on this - filesystem + filesystem. type: bool size_total_with_unit: description: Size of the filesystem with actual unit. type: str tiering_policy: - description: Tiering policy applied to this filesystem + description: Tiering policy applied to this filesystem. type: str is_cifs_notify_on_access_enabled: description: Indicates whether the system generates a @@ -374,19 +376,19 @@ enabled notifications apply, if any. type: int pool: - description: The pool in which this filesystem is allocated + description: The pool in which this filesystem is allocated. type: complex contains: UnityPool: description: Unity pool in which this filesystem is - allocated + allocated. type: complex contains: id: - description: The system ID given to the pool + description: The system ID given to the pool. type: str name: - description: The name of the storage pool + description: The name of the storage pool. type: str nas_server: description: The NAS Server details on which this filesystem is hosted. @@ -397,10 +399,10 @@ type: complex contains: id: - description: The system ID given to the NAS Server + description: The system ID given to the NAS Server. type: str name: - description: The name of the NAS Server + description: The name of the NAS Server. type: str snap_list: description: The list of snapshots of this filesystem. @@ -412,22 +414,22 @@ contains: id: description: The system ID given to the filesystem - snapshot + snapshot. type: str name: - description: The name of the filesystem snapshot + description: The name of the filesystem snapshot. type: str is_thin_enabled: description: Indicates whether thin provisioning is enabled for - this filesystem + this filesystem. type: bool snap_schedule_id: description: Indicates the id of the snap schedule associated - with the filesystem + with the filesystem. type: str snap_schedule_name: description: Indicates the name of the snap schedule associated - with the filesystem + with the filesystem. type: str quota_config: description: Details of quota configuration of the filesystem @@ -465,7 +467,7 @@ UNITY_SDK_VERSION_CHECK = utils.storops_version_check() -application_type = "Ansible/1.2.0" +application_type = "Ansible/1.2.1" class UnityFilesystem(object): @@ -990,7 +992,7 @@ def get_filesystem_display_attributes(self, obj_fs): self.module.fail_json(msg=errormsg) def validate_input_string(self): - """ validates the input string checks if it's empty string """ + """ validates the input string checks if it is empty string """ invalid_string = "" try: for key in self.module.params: diff --git a/plugins/modules/dellemc_unity_filesystem_snapshot.py b/plugins/modules/dellemc_unity_filesystem_snapshot.py index 6cb064f..4050a1e 100644 --- a/plugins/modules/dellemc_unity_filesystem_snapshot.py +++ b/plugins/modules/dellemc_unity_filesystem_snapshot.py @@ -1,5 +1,8 @@ #!/usr/bin/python # Copyright: (c) 2020, DellEMC + +# Apache License version 2.0 (see MODULE-LICENSE or http://www.apache.org/licenses/LICENSE-2.0.txt) + """ Ansible module for managing Filesystem Snapshots on Unity""" from __future__ import (absolute_import, division, print_function) @@ -112,7 +115,7 @@ EXAMPLES = r''' - name: Create Filesystem Snapshot - dellemc_unity_filesystem_snapshot: + dellemc.unity.dellemc_unity_filesystem_snapshot: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -125,8 +128,8 @@ fs_access_type: "Protocol" state: "present" - - name: Create Filesystem Snapshot with expiry time. - dellemc_unity_filesystem_snapshot: + - name: Create Filesystem Snapshot with expiry time + dellemc.unity.dellemc_unity_filesystem_snapshot: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -140,7 +143,7 @@ state: "present" - name: Get Filesystem Snapshot Details using Name - dellemc_unity_filesystem_snapshot: + dellemc.unity.dellemc_unity_filesystem_snapshot: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -149,7 +152,7 @@ state: "present" - name: Get Filesystem Snapshot Details using ID - dellemc_unity_filesystem_snapshot: + dellemc.unity.dellemc_unity_filesystem_snapshot: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -158,7 +161,7 @@ state: "present" - name: Update Filesystem Snapshot attributes - dellemc_unity_filesystem_snapshot: + dellemc.unity.dellemc_unity_filesystem_snapshot: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -170,7 +173,7 @@ state: "present" - name: Update Filesystem Snapshot attributes using ID - dellemc_unity_filesystem_snapshot: + dellemc.unity.dellemc_unity_filesystem_snapshot: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -180,7 +183,7 @@ state: "present" - name: Delete Filesystem Snapshot using Name - dellemc_unity_filesystem_snapshot: + dellemc.unity.dellemc_unity_filesystem_snapshot: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -189,7 +192,7 @@ state: "absent" - name: Delete Filesystem Snapshot using ID - dellemc_unity_filesystem_snapshot: + dellemc.unity.dellemc_unity_filesystem_snapshot: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -200,7 +203,7 @@ RETURN = r''' changed: - description: Whether or not the resource has changed + description: Whether or not the resource has changed. returned: always type: bool filesystem_snapshot_details: @@ -271,7 +274,7 @@ HAS_UNITY_SDK = utils.get_unity_sdk() UNITY_SDK_VERSION_CHECK = utils.storops_version_check() -application_type = "Ansible/1.2.0" +application_type = "Ansible/1.2.1" class UnityFilesystemSnapshot(object): diff --git a/plugins/modules/dellemc_unity_gatherfacts.py b/plugins/modules/dellemc_unity_gatherfacts.py index 9ba39bc..ef3d7d6 100644 --- a/plugins/modules/dellemc_unity_gatherfacts.py +++ b/plugins/modules/dellemc_unity_gatherfacts.py @@ -1,6 +1,8 @@ #!/usr/bin/python # Copyright: (c) 2020, DellEMC +# Apache License version 2.0 (see MODULE-LICENSE or http://www.apache.org/licenses/LICENSE-2.0.txt) + """Ansible module for Gathering information about DellEMC Unity""" from __future__ import absolute_import, division, print_function @@ -70,8 +72,8 @@ ''' EXAMPLES = r''' - - name: Get detailed list of Unity entities. - dellemc_unity_gatherfacts: + - name: Get detailed list of Unity entities + dellemc.unity.dellemc_unity_gatherfacts: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -92,15 +94,15 @@ - user_quota - tree_quota - - name: Get information of Unity array. - dellemc_unity_gatherfacts: + - name: Get information of Unity array + dellemc.unity.dellemc_unity_gatherfacts: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" verifycert: "{{verifycert}}" - - name: Get list of hosts on Unity array. - dellemc_unity_gatherfacts: + - name: Get list of hosts on Unity array + dellemc.unity.dellemc_unity_gatherfacts: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -108,8 +110,8 @@ gather_subset: - host - - name: Get list of FC initiators on Unity array. - dellemc_unity_gatherfacts: + - name: Get list of FC initiators on Unity array + dellemc.unity.dellemc_unity_gatherfacts: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -117,8 +119,8 @@ gather_subset: - fc_initiator - - name: Get list of ISCSI initiators on Unity array. - dellemc_unity_gatherfacts: + - name: Get list of ISCSI initiators on Unity array + dellemc.unity.dellemc_unity_gatherfacts: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -126,8 +128,8 @@ gather_subset: - iscsi_initiator - - name: Get list of consistency groups on Unity array. - dellemc_unity_gatherfacts: + - name: Get list of consistency groups on Unity array + dellemc.unity.dellemc_unity_gatherfacts: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -135,8 +137,8 @@ gather_subset: - cg - - name: Get list of storage pools on Unity array. - dellemc_unity_gatherfacts: + - name: Get list of storage pools on Unity array + dellemc.unity.dellemc_unity_gatherfacts: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -144,8 +146,8 @@ gather_subset: - storage_pool - - name: Get list of volumes on Unity array. - dellemc_unity_gatherfacts: + - name: Get list of volumes on Unity array + dellemc.unity.dellemc_unity_gatherfacts: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -153,8 +155,8 @@ gather_subset: - vol - - name: Get list of snapshot schedules on Unity array. - dellemc_unity_gatherfacts: + - name: Get list of snapshot schedules on Unity array + dellemc.unity.dellemc_unity_gatherfacts: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -162,8 +164,8 @@ gather_subset: - snapshot_schedule - - name: Get list of NAS Servers on Unity array. - dellemc_unity_gatherfacts: + - name: Get list of NAS Servers on Unity array + dellemc.unity.dellemc_unity_gatherfacts: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -171,8 +173,8 @@ gather_subset: - nas_server - - name: Get list of File Systems on Unity array. - dellemc_unity_gatherfacts: + - name: Get list of File Systems on Unity array + dellemc.unity.dellemc_unity_gatherfacts: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -180,8 +182,8 @@ gather_subset: - file_system - - name: Get list of Snapshots on Unity array. - dellemc_unity_gatherfacts: + - name: Get list of Snapshots on Unity array + dellemc.unity.dellemc_unity_gatherfacts: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -189,8 +191,8 @@ gather_subset: - snapshot - - name: Get list of NFS exports on Unity array. - dellemc_unity_gatherfacts: + - name: Get list of NFS exports on Unity array + dellemc.unity.dellemc_unity_gatherfacts: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -198,8 +200,8 @@ gather_subset: - nfs_export - - name: Get list of SMB shares on Unity array. - dellemc_unity_gatherfacts: + - name: Get list of SMB shares on Unity array + dellemc.unity.dellemc_unity_gatherfacts: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -207,8 +209,8 @@ gather_subset: - smb_share - - name: Get list of user quotas on Unity array. - dellemc_unity_gatherfacts: + - name: Get list of user quotas on Unity array + dellemc.unity.dellemc_unity_gatherfacts: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -216,8 +218,8 @@ gather_subset: - user_quota - - name: Get list of quota trees on Unity array. - dellemc_unity_gatherfacts: + - name: Get list of quota trees on Unity array + dellemc.unity.dellemc_unity_gatherfacts: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -425,7 +427,7 @@ HAS_UNITY_SDK = utils.get_unity_sdk() UNITY_SDK_VERSION_CHECK = utils.storops_version_check() -application_type = "Ansible/1.2.0" +application_type = "Ansible/1.2.1" class UnityGatherfacts(object): diff --git a/plugins/modules/dellemc_unity_host.py b/plugins/modules/dellemc_unity_host.py index 741025d..3191616 100644 --- a/plugins/modules/dellemc_unity_host.py +++ b/plugins/modules/dellemc_unity_host.py @@ -1,6 +1,8 @@ #!/usr/bin/python # Copyright: (c) 2020, DellEMC +# Apache License version 2.0 (see MODULE-LICENSE or http://www.apache.org/licenses/LICENSE-2.0.txt) + """Ansible module for managing host on Unity""" from __future__ import absolute_import, division, print_function @@ -16,7 +18,7 @@ version_added: '1.1.0' -short_description: Manage Host operations on Unity. +short_description: Manage Host operations on Unity description: - The Host module contains the following operations @@ -86,8 +88,8 @@ ''' EXAMPLES = r''' -- name: Create empty Host. - dellemc_unity_host: +- name: Create empty Host + dellemc.unity.dellemc_unity_host: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -97,8 +99,8 @@ description: "ansible-test-host" state: "present" -- name: Create Host with Initiators. - dellemc_unity_host: +- name: Create Host with Initiators + dellemc.unity.dellemc_unity_host: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -112,8 +114,8 @@ initiator_state: "present-in-host" state: "present" -- name: Modify Host using host_id. - dellemc_unity_host: +- name: Modify Host using host_id + dellemc.unity.dellemc_unity_host: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -124,8 +126,8 @@ description: "Ansible tesing purpose" state: "present" -- name: Add Initiators to Host. - dellemc_unity_host: +- name: Add Initiators to Host + dellemc.unity.dellemc_unity_host: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -136,8 +138,8 @@ initiator_state: "present-in-host" state: "present" -- name: Get Host details using host_name. - dellemc_unity_host: +- name: Get Host details using host_name + dellemc.unity.dellemc_unity_host: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -145,8 +147,8 @@ host_name: "ansible-test-host-2" state: "present" -- name: Get Host details using host_id. - dellemc_unity_host: +- name: Get Host details using host_id + dellemc.unity.dellemc_unity_host: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -154,8 +156,8 @@ host_id: "Host_253" state: "present" -- name: Delete Host. - dellemc_unity_host: +- name: Delete Host + dellemc.unity.dellemc_unity_host: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -215,11 +217,11 @@ from ansible_collections.dellemc.unity.plugins.module_utils.storage.dell \ import dellemc_ansible_unity_utils as utils -LOG = utils.get_logger('dellemc_unity_host', log_devel=utils.logging.INFO) +LOG = utils.get_logger('dellemc_unity_host') HAS_UNITY_SDK = utils.get_unity_sdk() UNITY_SDK_VERSION_CHECK = utils.storops_version_check() -application_type = "Ansible/1.2.0" +application_type = "Ansible/1.2.1" class UnityHost(object): diff --git a/plugins/modules/dellemc_unity_nasserver.py b/plugins/modules/dellemc_unity_nasserver.py index bb1a008..89eca96 100644 --- a/plugins/modules/dellemc_unity_nasserver.py +++ b/plugins/modules/dellemc_unity_nasserver.py @@ -1,5 +1,8 @@ #!/usr/bin/python # Copyright: (c) 2020, DellEMC + +# Apache License version 2.0 (see MODULE-LICENSE or http://www.apache.org/licenses/LICENSE-2.0.txt) + from __future__ import (absolute_import, division, print_function) __metaclass__ = type @@ -107,7 +110,7 @@ EXAMPLES = r''' - name: Get Details of NAS Server - dellemc_unity_nasserver: + dellemc.unity.dellemc_unity_nasserver: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -116,7 +119,7 @@ state: "present" - name: Modify Details of NAS Server - dellemc_unity_nasserver: + dellemc.unity.dellemc_unity_nasserver: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -198,7 +201,7 @@ HAS_UNITY_SDK = utils.get_unity_sdk() UNITY_SDK_VERSION_CHECK = utils.storops_version_check() -application_type = "Ansible/1.2.0" +application_type = "Ansible/1.2.1" class UnityNASServer(object): diff --git a/plugins/modules/dellemc_unity_nfs.py b/plugins/modules/dellemc_unity_nfs.py index 7aa43f0..cfe30d5 100644 --- a/plugins/modules/dellemc_unity_nfs.py +++ b/plugins/modules/dellemc_unity_nfs.py @@ -1,6 +1,8 @@ #!/usr/bin/python # Copyright: (c) 2020, DellEMC +# Apache License version 2.0 (see MODULE-LICENSE or http://www.apache.org/licenses/LICENSE-2.0.txt) + """Ansible module for managing nfs export on Unity""" from __future__ import absolute_import, division, print_function @@ -47,13 +49,13 @@ - Name of the filesystem for which NFS export will be created. - Either filesystem or snapshot is required for creation of the NFS. - If filesystem name is specified, then nas_server is required to uniquely - identify the filesystem + identify the filesystem. - If filesystem parameter is provided, then snapshot cannot be specified. required: False type: str filesystem_id: description: - - ID of the filesystem + - ID of the filesystem. - This is a unique ID generated by Unity storage system. required: False type: str @@ -169,7 +171,7 @@ description: - Hosts with read-only access to the NFS export. - List of dictionaries. Each dictionary will have any of the keys from - host_name, host_id, and ip_address + host_name, host_id, and ip_address. required: False type: list elements: dict @@ -193,7 +195,7 @@ description: - Hosts with read-only for root user access to the NFS export. - List of dictionaries. Each dictionary will have any of the keys from - host_name, host_id, and ip_address + host_name, host_id, and ip_address. required: False type: list elements: dict @@ -265,7 +267,7 @@ EXAMPLES = r""" - name: Create nfs export from filesystem - dellemc_unity_nfs: + dellemc.unity.dellemc_unity_nfs: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -276,7 +278,7 @@ state: "present" - name: Create nfs export from snapshot - dellemc_unity_nfs: + dellemc.unity.dellemc_unity_nfs: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -287,7 +289,7 @@ state: "present" - name: Modify nfs export - dellemc_unity_nfs: + dellemc.unity.dellemc_unity_nfs: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -301,7 +303,7 @@ state: "present" - name: Add host in nfs export - dellemc_unity_nfs: + dellemc.unity.dellemc_unity_nfs: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -322,7 +324,7 @@ state: "present" - name: Remove host in nfs export - dellemc_unity_nfs: + dellemc.unity.dellemc_unity_nfs: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -343,7 +345,7 @@ state: "present" - name: Get nfs details - dellemc_unity_nfs: + dellemc.unity.dellemc_unity_nfs: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -352,7 +354,7 @@ state: "present" - name: Delete nfs export by nfs name - dellemc_unity_nfs: + dellemc.unity.dellemc_unity_nfs: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -469,7 +471,7 @@ HOST_STATE_LIST = ['present-in-export', 'absent-in-export'] STATE_LIST = ['present', 'absent'] -application_type = "Ansible/1.2.0" +application_type = "Ansible/1.2.1" class UnityNFS(object): @@ -1477,7 +1479,7 @@ def get_unity_nfs_parameters(): snapshot_name=dict(required=False, type='str'), nas_server_id=dict(required=False, type='str'), nas_server_name=dict(required=False, type='str'), - path=dict(required=False, type='str'), + path=dict(required=False, type='str', no_log=True), description=dict(required=False, type='str'), default_access=dict(required=False, type='str', choices=DEFAULT_ACCESS_LIST), diff --git a/plugins/modules/dellemc_unity_smbshare.py b/plugins/modules/dellemc_unity_smbshare.py index 1c2deb6..169ecfb 100644 --- a/plugins/modules/dellemc_unity_smbshare.py +++ b/plugins/modules/dellemc_unity_smbshare.py @@ -1,5 +1,8 @@ #!/usr/bin/python # Copyright: (c) 2020, DellEMC + +# Apache License version 2.0 (see MODULE-LICENSE or http://www.apache.org/licenses/LICENSE-2.0.txt) + from __future__ import (absolute_import, division, print_function) __metaclass__ = type @@ -12,7 +15,7 @@ --- module: dellemc_unity_smbshare version_added: '1.1.0' -short_description: Manage SMB shares on Unity storage system. +short_description: Manage SMB shares on Unity storage system extends_documentation_fragment: - dellemc.unity.dellemc_unity.unity author: @@ -140,7 +143,7 @@ EXAMPLES = r''' - name: Create SMB share for a filesystem - dellemc_unity_smbshare: + dellemc.unity.dellemc_unity_smbshare: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -158,7 +161,7 @@ umask: "777" state: "present" - name: Modify Attributes of SMB share for a filesystem - dellemc_unity_smbshare: + dellemc.unity.dellemc_unity_smbshare: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -174,7 +177,7 @@ umask: "022" state: "present" - name: Create SMB share for a snapshot - dellemc_unity_smbshare: + dellemc.unity.dellemc_unity_smbshare: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -191,7 +194,7 @@ umask: "777" state: "present" - name: Modify Attributes of SMB share for a snapshot - dellemc_unity_smbshare: + dellemc.unity.dellemc_unity_smbshare: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -207,7 +210,7 @@ umask: "022" state: "present" - name: Get details of SMB share - dellemc_unity_smbshare: + dellemc.unity.dellemc_unity_smbshare: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -215,7 +218,7 @@ share_id: "{{smb_share_id}}" state: "present" - name: Delete SMB share - dellemc_unity_smbshare: + dellemc.unity.dellemc_unity_smbshare: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -226,7 +229,7 @@ RETURN = r''' changed: - description: Whether or not the resource has changed + description: Whether or not the resource has changed. returned: always type: bool sample: True @@ -293,7 +296,7 @@ HAS_UNITY_SDK = utils.get_unity_sdk() UNITY_SDK_VERSION_CHECK = utils.storops_version_check() -application_type = "Ansible/1.2.0" +application_type = "Ansible/1.2.1" class UnitySMBShare(object): @@ -834,7 +837,7 @@ def get_unity_smb_share_parameters(): filesystem_name=dict(), filesystem_id=dict(), snapshot_name=dict(), snapshot_id=dict(), nas_server_name=dict(), nas_server_id=dict(), - path=dict(), umask=dict(), description=dict(), + path=dict(no_log=True), umask=dict(), description=dict(), offline_availability=dict( choices=["MANUAL", "DOCUMENTS", "PROGRAMS", "NONE"]), is_abe_enabled=dict(type='bool'), diff --git a/plugins/modules/dellemc_unity_snapshot.py b/plugins/modules/dellemc_unity_snapshot.py index bd43982..f3e9664 100644 --- a/plugins/modules/dellemc_unity_snapshot.py +++ b/plugins/modules/dellemc_unity_snapshot.py @@ -1,5 +1,8 @@ #!/usr/bin/python # Copyright: (c) 2020, DellEMC + +# Apache License version 2.0 (see MODULE-LICENSE or http://www.apache.org/licenses/LICENSE-2.0.txt) + """ Ansible module for managing Snapshots on Unity""" from __future__ import (absolute_import, division, print_function) @@ -12,7 +15,7 @@ DOCUMENTATION = r''' --- module: dellemc_unity_snapshot -short_description: Manage snapshots on the Unity storage system. +short_description: Manage snapshots on the Unity storage system description: - Managing snapshots on the Unity storage system includes create snapshot, delete snapshot, update snapshot, get snapshot, map host and unmap host. @@ -96,7 +99,7 @@ description: - The id of the host. - Either host_name or host_id is required to map or unmap a snapshot from - a host + a host. - Snapshot can be attached to multiple hosts. type: str host_state: @@ -110,7 +113,7 @@ EXAMPLES = r''' - name: Create a Snapshot for a CG - dellemc_unity_snapshot: + dellemc.unity.dellemc_unity_snapshot: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -122,8 +125,8 @@ auto_delete: False state: "present" - - name: Create a Snapshot for a volume with Host attached. - dellemc_unity_snapshot: + - name: Create a Snapshot for a volume with Host attached + dellemc.unity.dellemc_unity_snapshot: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -138,7 +141,7 @@ state: "present" - name: Unmap a host for a Snapshot - dellemc_unity_snapshot: + dellemc.unity.dellemc_unity_snapshot: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -150,7 +153,7 @@ state: "present" - name: Map snapshot to a host - dellemc_unity_snapshot: + dellemc.unity.dellemc_unity_snapshot: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -162,7 +165,7 @@ state: "present" - name: Update attributes of a Snapshot for a volume - dellemc_unity_snapshot: + dellemc.unity.dellemc_unity_snapshot: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -174,8 +177,8 @@ host_state: "unmapped" state: "present" - - name: Delete Snapshot of CG. - dellemc_unity_snapshot: + - name: Delete Snapshot of CG + dellemc.unity.dellemc_unity_snapshot: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -186,7 +189,7 @@ RETURN = r''' changed: - description: Whether or not the resource has changed + description: Whether or not the resource has changed. returned: always type: bool snapshot_details: @@ -228,8 +231,7 @@ import dellemc_ansible_unity_utils as utils from datetime import datetime -LOG = utils.get_logger('dellemc_unity_snapshot', - log_devel=logging.INFO) +LOG = utils.get_logger('dellemc_unity_snapshot') HAS_UNITY_SDK = utils.get_unity_sdk() UNITY_SDK_VERSION_CHECK = utils.storops_version_check() @@ -550,7 +552,7 @@ def perform_module_operation(self): if new_snapshot_name: self.module.fail_json( - msg="new_snapshot_name can't be assigned" + msg="new_snapshot_name can not be assigned" " during creation of a snapshot") snapshot = self.create_snapshot(snapshot_name, diff --git a/plugins/modules/dellemc_unity_snapshotschedule.py b/plugins/modules/dellemc_unity_snapshotschedule.py index a4fcd46..9fb02f5 100644 --- a/plugins/modules/dellemc_unity_snapshotschedule.py +++ b/plugins/modules/dellemc_unity_snapshotschedule.py @@ -1,6 +1,8 @@ #!/usr/bin/python # Copyright: (c) 2020, DellEMC +# Apache License version 2.0 (see MODULE-LICENSE or http://www.apache.org/licenses/LICENSE-2.0.txt) + """Ansible module for managing snapshot schedules on Unity""" from __future__ import absolute_import, division, print_function @@ -77,7 +79,7 @@ type: int hour: description: - - the hour when the snapshot will be taken. + - The hour when the snapshot will be taken. - Applicable for 'every_n_days', 'every_week', 'every_month' rule types. - For create operation, if 'hour' parameter is not specified, value will be taken as 0. @@ -114,7 +116,7 @@ required: true choices: [absent, present] notes: -- Snapshot schedule created via Ansible will have only one rule. +- Snapshot schedule created through Ansible will have only one rule. - Modification of rule type is not allowed. Within the same type, other parameters can be modified. - If an existing snapshot schedule has more than 1 rule in it, only get and @@ -123,7 +125,7 @@ EXAMPLES = r""" - name: Create snapshot schedule (Rule Type - every_n_hours) - dellemc_unity_snapshotschedule: + dellemc.unity.dellemc_unity_snapshotschedule: unispherehost: "{{unispherehost}}" verifycert: "{{verifycert}}" username: "{{username}}" @@ -135,7 +137,7 @@ state: "{{state_present}}" - name: Create snapshot schedule (Rule Type - every_day) - dellemc_unity_snapshotschedule: + dellemc.unity.dellemc_unity_snapshotschedule: unispherehost: "{{unispherehost}}" verifycert: "{{verifycert}}" username: "{{username}}" @@ -149,7 +151,7 @@ state: "{{state_present}}" - name: Create snapshot schedule (Rule Type - every_n_days) - dellemc_unity_snapshotschedule: + dellemc.unity.dellemc_unity_snapshotschedule: unispherehost: "{{unispherehost}}" verifycert: "{{verifycert}}" username: "{{username}}" @@ -162,7 +164,7 @@ state: "{{state_present}}" - name: Create snapshot schedule (Rule Type - every_week) - dellemc_unity_snapshotschedule: + dellemc.unity.dellemc_unity_snapshotschedule: unispherehost: "{{unispherehost}}" verifycert: "{{verifycert}}" username: "{{username}}" @@ -178,7 +180,7 @@ state: "{{state_present}}" - name: Create snapshot schedule (Rule Type - every_month) - dellemc_unity_snapshotschedule: + dellemc.unity.dellemc_unity_snapshotschedule: unispherehost: "{{unispherehost}}" verifycert: "{{verifycert}}" username: "{{username}}" @@ -190,7 +192,7 @@ state: "{{state_present}}" - name: Get snapshot schedule details using name - dellemc_unity_snapshotschedule: + dellemc.unity.dellemc_unity_snapshotschedule: unispherehost: "{{unispherehost}}" verifycert: "{{verifycert}}" username: "{{username}}" @@ -199,7 +201,7 @@ state: "{{state_present}}" - name: Get snapshot schedule details using id - dellemc_unity_snapshotschedule: + dellemc.unity.dellemc_unity_snapshotschedule: unispherehost: "{{unispherehost}}" verifycert: "{{verifycert}}" username: "{{username}}" @@ -208,7 +210,7 @@ state: "{{state_present}}" - name: Modify snapshot schedule details id - dellemc_unity_snapshotschedule: + dellemc.unity.dellemc_unity_snapshotschedule: unispherehost: "{{unispherehost}}" verifycert: "{{verifycert}}" username: "{{username}}" @@ -219,7 +221,7 @@ state: "{{state_present}}" - name: Modify snapshot schedule using name - dellemc_unity_snapshotschedule: + dellemc.unity.dellemc_unity_snapshotschedule: unispherehost: "{{unispherehost}}" verifycert: "{{verifycert}}" username: "{{username}}" @@ -231,7 +233,7 @@ state: "{{state_present}}" - name: Delete snapshot schedule using id - dellemc_unity_snapshotschedule: + dellemc.unity.dellemc_unity_snapshotschedule: unispherehost: "{{unispherehost}}" verifycert: "{{verifycert}}" username: "{{username}}" @@ -240,7 +242,7 @@ state: "{{state_absent}}" - name: Delete snapshot schedule using name - dellemc_unity_snapshotschedule: + dellemc.unity.dellemc_unity_snapshotschedule: unispherehost: "{{unispherehost}}" verifycert: "{{verifycert}}" username: "{{username}}" @@ -362,7 +364,7 @@ UNITY_SDK_VERSION_CHECK = utils.storops_version_check() -application_type = "Ansible/1.2.0" +application_type = "Ansible/1.2.1" class UnitySnapshotSchedule(object): diff --git a/plugins/modules/dellemc_unity_storagepool.py b/plugins/modules/dellemc_unity_storagepool.py index 1152bfa..0a60e64 100644 --- a/plugins/modules/dellemc_unity_storagepool.py +++ b/plugins/modules/dellemc_unity_storagepool.py @@ -1,6 +1,8 @@ #!/usr/bin/python # Copyright: (c) 2020, DellEMC +# Apache License version 2.0 (see MODULE-LICENSE or http://www.apache.org/licenses/LICENSE-2.0.txt) + """Ansible module for managing storage pool on Unity""" from __future__ import absolute_import, division, print_function @@ -12,17 +14,13 @@ } DOCUMENTATION = r''' ---- module: dellemc_unity_storagepool - version_added: '1.1.0' - short_description: Manage storage pool on Unity - description: -- Managing storage pool on Unity storage system contains the following operations -- Get details of storage pool -- Modify storage pool +- Managing storage pool on Unity storage system contains the following operations. +- Get details of storage pool. +- Modify storage pool. extends_documentation_fragment: - dellemc.unity.dellemc_unity.unity @@ -82,7 +80,7 @@ EXAMPLES = r''' - name: Get Storage pool details using pool_name - dellemc_unity_storagepool: + dellemc.unity.dellemc_unity_storagepool: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -91,7 +89,7 @@ state: "present" - name: Get Storage pool details using pool_id - dellemc_unity_storagepool: + dellemc.unity.dellemc_unity_storagepool: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -100,7 +98,7 @@ state: "present" - name: Modify Storage pool attributes using pool_name - dellemc_unity_storagepool: + dellemc.unity.dellemc_unity_storagepool: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -113,7 +111,7 @@ state: "present" - name: Modify Storage pool attributes using pool_id - dellemc_unity_storagepool: + dellemc.unity.dellemc_unity_storagepool: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -187,14 +185,14 @@ import dellemc_ansible_unity_utils as utils import logging -LOG = utils.get_logger('dellemc_unity_storagepool', log_devel=logging.INFO) +LOG = utils.get_logger('dellemc_unity_storagepool') HAS_UNITY_SDK = utils.get_unity_sdk() UNITY_SDK_VERSION = utils.storops_version_check() UNITY_SDK_VERSION_CHECK = UNITY_SDK_VERSION['supported_version'] UNITY_SDK_VERSION_ERROR = UNITY_SDK_VERSION['unsupported_version_message'] -application_type = "Ansible/1.2.0" +application_type = "Ansible/1.2.1" class UnityStoragePool(object): diff --git a/plugins/modules/dellemc_unity_tree_quota.py b/plugins/modules/dellemc_unity_tree_quota.py index 99db330..6911663 100644 --- a/plugins/modules/dellemc_unity_tree_quota.py +++ b/plugins/modules/dellemc_unity_tree_quota.py @@ -1,6 +1,8 @@ #!/usr/bin/python # Copyright: (c) 2021, DellEMC +# Apache License version 2.0 (see MODULE-LICENSE or http://www.apache.org/licenses/LICENSE-2.0.txt) + """Ansible module for managing quota tree on Unity""" from __future__ import absolute_import, division, print_function @@ -20,7 +22,7 @@ Create quota tree, Get quota tree, Modify quota tree and - Delete quota tree + Delete quota tree. version_added: "1.2.0" extends_documentation_fragment: - dellemc.unity.dellemc_unity.unity @@ -101,7 +103,7 @@ EXAMPLES = r''' - name: Get quota tree details by quota tree id - dellemc_unity_tree_quota: + dellemc.unity.dellemc_unity_tree_quota: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -110,7 +112,7 @@ state: "present" - name: Get quota tree details by quota tree path - dellemc_unity_tree_quota: + dellemc.unity.dellemc_unity_tree_quota: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -121,7 +123,7 @@ state: "present" - name: Create quota tree for a filesystem with filesystem id - dellemc_unity_tree_quota: + dellemc.unity.dellemc_unity_tree_quota: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -134,7 +136,7 @@ state: "present" - name: Create quota tree for a filesystem with filesystem name - dellemc_unity_tree_quota: + dellemc.unity.dellemc_unity_tree_quota: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -148,7 +150,7 @@ state: "present" - name: Modify quota tree limit usage by quota tree path - dellemc_unity_tree_quota: + dellemc.unity.dellemc_unity_tree_quota: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -160,7 +162,7 @@ state: "present" - name: Modify quota tree by quota tree id - dellemc_unity_tree_quota: + dellemc.unity.dellemc_unity_tree_quota: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -173,7 +175,7 @@ state: "present" - name: Delete quota tree by quota tree id - dellemc_unity_tree_quota: + dellemc.unity.dellemc_unity_tree_quota: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -183,7 +185,7 @@ state: "absent" - name: Delete quota tree by path - dellemc_unity_tree_quota: + dellemc.unity.dellemc_unity_tree_quota: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -195,7 +197,7 @@ RETURN = r''' changed: - description: Whether or not the resource has changed + description: Whether or not the resource has changed. returned: always type: bool get_quota_tree_details: @@ -261,6 +263,8 @@ UNITY_SDK_VERSION_CHECK = utils.storops_version_check() +application_type = "Ansible/1.2.1" + class UnityQuotaTree(object): """Class with Quota Tree operations""" @@ -292,7 +296,7 @@ def __init__(self): self.module.fail_json(msg=err_msg) self.unity_conn = utils.get_unity_unisphere_connection( - self.module.params) + self.module.params, application_type) def check_quota_tree_is_present(self, fs_id, path, tree_quota_id): """ @@ -679,7 +683,7 @@ def get_unity_quota_tree_parameters(): tree_quota_id=dict(required=False, type='str'), nas_server_name=dict(required=False, type='str'), nas_server_id=dict(required=False, type='str'), - path=dict(required=False, type='str'), + path=dict(required=False, type='str', no_log=True), description=dict(required=False, type='str') ) diff --git a/plugins/modules/dellemc_unity_user_quota.py b/plugins/modules/dellemc_unity_user_quota.py index 180b3a5..49da7e2 100644 --- a/plugins/modules/dellemc_unity_user_quota.py +++ b/plugins/modules/dellemc_unity_user_quota.py @@ -1,6 +1,8 @@ #!/usr/bin/python # Copyright: (c) 2021, DellEMC +# Apache License version 2.0 (see MODULE-LICENSE or http://www.apache.org/licenses/LICENSE-2.0.txt) + """Ansible module for managing User Quota on Unity""" from __future__ import absolute_import, division, print_function @@ -123,7 +125,7 @@ EXAMPLES = r''' - name: Get user quota details by user quota id - dellemc_unity_user_quota: + dellemc.unity.dellemc_unity_user_quota: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -132,7 +134,7 @@ state: "present" - name: Get user quota details by user quota uid/user name - dellemc_unity_user_quota: + dellemc.unity.dellemc_unity_user_quota: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -143,7 +145,7 @@ state: "present" - name: Create user quota for a filesystem with filesystem id - dellemc_unity_user_quota: + dellemc.unity.dellemc_unity_user_quota: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -152,12 +154,11 @@ hard_limit: 6 cap_unit: "TB" soft_limit: 5 - user_type: "UID" uid: "111" state: "present" - name: Create user quota for a filesystem with filesystem name - dellemc_unity_user_quota: + dellemc.unity.dellemc_unity_user_quota: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -167,12 +168,11 @@ hard_limit: 6 cap_unit: "TB" soft_limit: 5 - user_type: "UID" uid: "111" state: "present" - name: Modify user quota limit usage by user quota id - dellemc_unity_user_quota: + dellemc.unity.dellemc_unity_user_quota: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -184,7 +184,7 @@ state: "present" - name: Modify user quota by filesystem id and user quota uid/user_name - dellemc_unity_user_quota: + dellemc.unity.dellemc_unity_user_quota: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -199,7 +199,7 @@ state: "present" - name: Delete user quota - dellemc_unity_user_quota: + dellemc.unity.dellemc_unity_user_quota: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -210,7 +210,7 @@ state: "absent" - name: Create user quota of a quota tree - dellemc_unity_user_quota: + dellemc.unity.dellemc_unity_user_quota: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -224,7 +224,7 @@ state: "present" - name: Create user quota of a quota tree by quota tree path - dellemc_unity_user_quota: + dellemc.unity.dellemc_unity_user_quota: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -238,7 +238,7 @@ state: "present" - name: Modify user quota of a quota tree - dellemc_unity_user_quota: + dellemc.unity.dellemc_unity_user_quota: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -252,7 +252,7 @@ state: "present" - name: Modify user quota of a quota tree by quota tree path - dellemc_unity_user_quota: + dellemc.unity.dellemc_unity_user_quota: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -267,7 +267,7 @@ state: "present" - name: Delete user quota of a quota tree by quota tree path - dellemc_unity_user_quota: + dellemc.unity.dellemc_unity_user_quota: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -279,7 +279,7 @@ state: "absent" - name: Delete user quota of a quota tree by quota tree id - dellemc_unity_user_quota: + dellemc.unity.dellemc_unity_user_quota: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -292,7 +292,7 @@ RETURN = r''' changed: - description: Whether or not the resource has changed + description: Whether or not the resource has changed. returned: always type: bool get_user_quota_details: @@ -403,7 +403,7 @@ UNITY_SDK_VERSION_CHECK = utils.storops_version_check() -application_type = "Ansible/1.2.0" +application_type = "Ansible/1.2.1" class UnityUserQuota(object): @@ -985,7 +985,7 @@ def get_unity_user_quota_parameters(): nas_server_name=dict(required=False, type='str'), nas_server_id=dict(required=False, type='str'), tree_quota_id=dict(required=False, type='str'), - path=dict(required=False, type='str') + path=dict(required=False, type='str', no_log=True) ) diff --git a/plugins/modules/dellemc_unity_volume.py b/plugins/modules/dellemc_unity_volume.py index 2837d64..07cecc9 100644 --- a/plugins/modules/dellemc_unity_volume.py +++ b/plugins/modules/dellemc_unity_volume.py @@ -1,6 +1,8 @@ #!/usr/bin/python # Copyright: (c) 2020, DellEMC +# Apache License version 2.0 (see MODULE-LICENSE or http://www.apache.org/licenses/LICENSE-2.0.txt) + """Ansible module for managing volumes on Unity""" from __future__ import absolute_import, division, print_function @@ -23,7 +25,7 @@ Map Volume to host, Unmap volume to host, Display volume details, - Delete volume + Delete volume. extends_documentation_fragment: - dellemc.unity.dellemc_unity.unity @@ -75,11 +77,11 @@ compression: description: - Boolean variable , specifies whether or not to enable compression. - Compression is supported only for thin volumes + Compression is supported only for thin volumes. type: bool is_thin: description: - - Boolean variable , specifies whether or not it's a thin volume. + - Boolean variable , specifies whether or not it is a thin volume. default: True type: bool sp: @@ -90,7 +92,7 @@ io_limit_policy: description: - IO limit policy associated with this volume. - Once it's set, it cannot be removed through ansible module but it can + Once it is set, it cannot be removed through ansible module but it can be changed. type: str host_name: @@ -108,7 +110,7 @@ hlu: description: - Host Lun Unit to be mapped/unmapped with this volume. - - It's an optional parameter, hlu can be specified along + - It is an optional parameter, hlu can be specified along with host_name or host_id and mapping_state. - If hlu is not specified, unity will choose it automatically. The maximum value supported is 255. @@ -136,7 +138,7 @@ type: str hosts: description: - - Name of hosts for mapping to a volume + - Name of hosts for mapping to a volume. type: list elements: dict suboptions: @@ -151,7 +153,7 @@ hlu: description: - Host Lun Unit to be mapped/unmapped with this volume. - - It's an optional parameter, hlu can be specified along + - It is an optional parameter, hlu can be specified along with host_name or host_id and mapping_state. - If hlu is not specified, unity will choose it automatically. The maximum value supported is 255. @@ -160,7 +162,7 @@ EXAMPLES = r""" - name: Create Volume - dellemc_unity_volume: + dellemc.unity.dellemc_unity_volume: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -173,7 +175,7 @@ state: "{{state_present}}" - name: Expand Volume by volume id - dellemc_unity_volume: + dellemc.unity.dellemc_unity_volume: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -184,7 +186,7 @@ state: "{{state_present}}" - name: Modify Volume, map host by host_name - dellemc_unity_volume: + dellemc.unity.dellemc_unity_volume: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -196,7 +198,7 @@ state: "{{state_present}}" - name: Modify Volume, unmap host mapping by host_name - dellemc_unity_volume: + dellemc.unity.dellemc_unity_volume: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -207,7 +209,7 @@ state: "{{state_present}}" - name: Map multiple hosts to a Volume - dellemc_unity_volume: + dellemc.unity.dellemc_unity_volume: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -222,7 +224,7 @@ state: "present" - name: Modify Volume attributes - dellemc_unity_volume: + dellemc.unity.dellemc_unity_volume: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -234,7 +236,7 @@ state: "{{state_present}}" - name: Delete Volume by vol name - dellemc_unity_volume: + dellemc.unity.dellemc_unity_volume: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -243,7 +245,7 @@ state: "{{state_absent}}" - name: Delete Volume by vol id - dellemc_unity_volume: + dellemc.unity.dellemc_unity_volume: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" @@ -255,12 +257,12 @@ RETURN = r''' changed: - description: Whether or not the resource has changed + description: Whether or not the resource has changed. returned: always type: bool volume_details: - description: Details of the volume + description: Details of the volume. returned: When volume exists type: complex contains: @@ -317,7 +319,7 @@ UNITY_SDK_VERSION_CHECK = utils.storops_version_check() -application_type = "Ansible/1.2.0" +application_type = "Ansible/1.2.1" def is_none_or_empty_string(param): @@ -894,7 +896,7 @@ def get_volume_display_attributes(self, obj_vol): self.module.fail_json(msg=errormsg) def validate_input_string(self): - """ validates the input string checks if it's empty string + """ validates the input string checks if it is empty string """ invalid_string = "" diff --git a/tests/sanity/ignore-2.10.txt b/tests/sanity/ignore-2.10.txt new file mode 100644 index 0000000..d9e068f --- /dev/null +++ b/tests/sanity/ignore-2.10.txt @@ -0,0 +1,16 @@ +plugins/modules/dellemc_unity_nfs.py compile-2.6 +plugins/modules/dellemc_unity_nfs.py import-2.6 +plugins/modules/dellemc_unity_consistencygroup.py validate-modules:missing-gplv3-license +plugins/modules/dellemc_unity_filesystem.py validate-modules:missing-gplv3-license +plugins/modules/dellemc_unity_filesystem_snapshot.py validate-modules:missing-gplv3-license +plugins/modules/dellemc_unity_gatherfacts.py validate-modules:missing-gplv3-license +plugins/modules/dellemc_unity_host.py validate-modules:missing-gplv3-license +plugins/modules/dellemc_unity_nasserver.py validate-modules:missing-gplv3-license +plugins/modules/dellemc_unity_nfs.py validate-modules:missing-gplv3-license +plugins/modules/dellemc_unity_smbshare.py validate-modules:missing-gplv3-license +plugins/modules/dellemc_unity_snapshot.py validate-modules:missing-gplv3-license +plugins/modules/dellemc_unity_snapshotschedule.py validate-modules:missing-gplv3-license +plugins/modules/dellemc_unity_storagepool.py validate-modules:missing-gplv3-license +plugins/modules/dellemc_unity_tree_quota.py validate-modules:missing-gplv3-license +plugins/modules/dellemc_unity_user_quota.py validate-modules:missing-gplv3-license +plugins/modules/dellemc_unity_volume.py validate-modules:missing-gplv3-license \ No newline at end of file diff --git a/tests/sanity/ignore-2.9.txt b/tests/sanity/ignore-2.9.txt new file mode 100644 index 0000000..d9e068f --- /dev/null +++ b/tests/sanity/ignore-2.9.txt @@ -0,0 +1,16 @@ +plugins/modules/dellemc_unity_nfs.py compile-2.6 +plugins/modules/dellemc_unity_nfs.py import-2.6 +plugins/modules/dellemc_unity_consistencygroup.py validate-modules:missing-gplv3-license +plugins/modules/dellemc_unity_filesystem.py validate-modules:missing-gplv3-license +plugins/modules/dellemc_unity_filesystem_snapshot.py validate-modules:missing-gplv3-license +plugins/modules/dellemc_unity_gatherfacts.py validate-modules:missing-gplv3-license +plugins/modules/dellemc_unity_host.py validate-modules:missing-gplv3-license +plugins/modules/dellemc_unity_nasserver.py validate-modules:missing-gplv3-license +plugins/modules/dellemc_unity_nfs.py validate-modules:missing-gplv3-license +plugins/modules/dellemc_unity_smbshare.py validate-modules:missing-gplv3-license +plugins/modules/dellemc_unity_snapshot.py validate-modules:missing-gplv3-license +plugins/modules/dellemc_unity_snapshotschedule.py validate-modules:missing-gplv3-license +plugins/modules/dellemc_unity_storagepool.py validate-modules:missing-gplv3-license +plugins/modules/dellemc_unity_tree_quota.py validate-modules:missing-gplv3-license +plugins/modules/dellemc_unity_user_quota.py validate-modules:missing-gplv3-license +plugins/modules/dellemc_unity_volume.py validate-modules:missing-gplv3-license \ No newline at end of file