├── LICENSE ├── NitroConfigurationFunctions └── NITROConfigurationFunctions.psm1 ├── README.md └── Scripts └── NSVPX_HyperVisorImport ├── NSVPX_Import_ESX_v1_1.ps1 └── NSVPX_Import_XS_v1_1.ps1 /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright {yyyy} {name of copyright owner} 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # PS-NITRO 2 | PowerShell Module for NITRO (REST API) communication with Citrix NetScaler (Automation DevOps) 3 | 4 | I have uploaded the latest version of my PowerShell Module code and the sample scripts used in the Citrix Synergy presentation to the Citrix_Synergy_2017 branch. I'm currently working on the NewModuleStructure branch to transform the Module file into a well structured Module to ensure it can be easier extended with new functions and used for collaborations. 5 | 6 | As I am still learning PowerShell every day I will work on creating new PowerShell module (learning all about manifest files now) that will use separate script files for the different NetScaler features. This will allow me to more easily work on separate parts of the code and cmdlets and really dig into the NetScaler NITRO configurations. 7 | 8 | So have fun with the code and I'm looking forward to any feedback and improvements for the code! 9 | 10 | Cheers, 11 | Esther 12 | 13 | P.S. For backwards compatibility with the original PowerShell NITRO Module, provided by Citrix through their blog, I've included the original disclaimer used for the scripts: 14 | 15 | ### Disclaimer: 16 | *This software / sample code is provided to you “AS IS” with no representations, warranties or conditions of any kind. You may use, modify and distribute it at your own risk. CITRIX DISCLAIMS ALL WARRANTIES WHATSOEVER, EXPRESS, IMPLIED, WRITTEN, ORAL OR STATUTORY, INCLUDING WITHOUT LIMITATION WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NONINFRINGEMENT. Without limiting the generality of the foregoing, you acknowledge and agree that (a) the software / sample code may exhibit errors, design flaws or other problems, possibly resulting in loss of data or damage to property; (b) it may not be possible to make the software / sample code fully functional; and (c) Citrix may, without notice or liability to you, cease to make available the current version and/or any future versions of the software / sample code. In no event should the software / code be used to support of ultra-hazardous activities, including but not limited to life support or blasting activities. NEITHER CITRIX NOR ITS AFFILIATES OR AGENTS WILL BE LIABLE, UNDER BREACH OF CONTRACT OR ANY OTHER THEORY OF LIABILITY, FOR ANY DAMAGES WHATSOEVER ARISING FROM USE OF THE SOFTWARE / SAMPLE CODE, INCLUDING WITHOUT LIMITATION DIRECT, SPECIAL, INCIDENTAL, PUNITIVE, CONSEQUENTIAL OR OTHER DAMAGES, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. You agree to indemnify and defend Citrix against any and all claims arising from your use, modification or distribution of the code.* 17 | -------------------------------------------------------------------------------- /Scripts/NSVPX_HyperVisorImport/NSVPX_Import_ESX_v1_1.ps1: -------------------------------------------------------------------------------- 1 | <# 2 | .SYNOPSIS 3 | Citrix NetScaler VPX import script for ESX. 4 | .DESCRIPTION 5 | Citrix NetScaler VPX import script for ESX importing the virtual appliance with a fixed IP. 6 | .NOTES 7 | Version: 1.2 8 | Author: Esther Barthel, MSc 9 | Creation Date: 2016-01-16 10 | 11 | Copyright (c) cognition IT. All rights reserved. 12 | 13 | Requires a local installation of PowerCLI Snapins for PowerShell 14 | 15 | Based upon Citrix Knowledgebase article: http://support.citrix.com/article/ctx128250 16 | #> 17 | 18 | # Constants 19 | $VMDefaultName = "NSVPX-ESX" # Default name of NetScaler VPX 20 | $FirstNICDefaultName = "Network adapter 1" # Default name of the first NIC 21 | 22 | # vSphere variables 23 | $vServer = "xxx.xxx.xxx.xxx" # IP address of the ESX host 24 | $vAppSource = "C:\Install\NSVPX-ESX-11.0-63.16_nc.ovf" # NetScaler OVF file to import 25 | $ESXiHostName = "xxxxx" # Name of the ESX(i) host 26 | 27 | # VM variables 28 | $VMName = "NSVPX-FixedIP" 29 | $IPaddress = "10.1.1.231" 30 | $SubnetMask = "255.255.255.0" 31 | $DefaultGW = "10.1.1.1" 32 | $VMNetworkName = "Internal Network" 33 | 34 | # Optional VM variable (can be useful for NetScaler license management). The MAC address must be in the valid "manual" range 00:50:56:00:00:00 - 00:50:56:3F:FF:FF. 35 | $MACaddress = "00:50:56:34:05:58" 36 | 37 | #Check version of PowerCLI and use appropiate method for adding cmdlets 38 | If ((Get-Command Connect-ViServer -ErrorAction SilentlyContinue) -eq $null) 39 | { 40 | $powercliVersion = $(Get-Module -ListAvailable | where {$_.name -match "VMware.VimAutomation.Core"}).Version.Major 41 | 42 | if ($powercliVersion -ge 6){ 43 | import-module VMware.VimAutomation.Core 44 | } 45 | else { 46 | Add-PSSnapin VMware.VimAutomation.Core 47 | } 48 | Write-Verbose -Message "Adding the VMware.VimAutomation.Core PowerShell component..." -Verbose 49 | } 50 | 51 | # Connect to the vSphere server 52 | Connect-VIServer -Server $vServer -WarningAction SilentlyContinue 53 | 54 | # Import OVF on specified ESXi Host 55 | $vmHost = Get-VMHost -Name $ESXiHostName 56 | Import-vApp -Source $vAppSource -VMHost $vmHost -Force -WarningAction SilentlyContinue 57 | 58 | # Get VM (based upon default name after import) 59 | $VM = Get-VM -Name $VMDefaultName -Server $ESXiHostName 60 | 61 | # Change the Network Adapter network 62 | $VMFirstNIC = Get-NetworkAdapter -VM $VM | Where-Object {$_.Name -eq $FirstNICDefaultName} 63 | 64 | If (($MACaddress -eq $null) -or ($MACaddress -eq "")) 65 | { 66 | # Change the first Network adapter's Network (MAC address is auto generated) 67 | Set-NetworkAdapter $VMFirstNIC -NetworkName $VMNetworkName -Confirm:$false 68 | } 69 | Else 70 | { 71 | # Change the first Network adapter's Network name and provide a fixed MAC address 72 | Set-NetworkAdapter $VMFirstNIC -NetworkName $VMNetworkName -MacAddress $MACaddress -Confirm:$false 73 | } 74 | # Change the VM name 75 | Set-VM -VM $VM -Name $VMName -Confirm:$false 76 | 77 | # Configure fixed IP for NetScaler 78 | New-AdvancedSetting $VM -Type VM -Name "machine.id" -Value "ip=$IPaddress&netmask=$SubnetMask&gateway=$DefaultGW" -Confirm:$false -Force:$true -WarningAction SilentlyContinue 79 | 80 | # Start VM 81 | Start-VM $VM 82 | 83 | # Disconnect from the vShpere Server 84 | Disconnect-VIServer -Server $vServer -Confirm:$false -WarningAction SilentlyContinue -------------------------------------------------------------------------------- /Scripts/NSVPX_HyperVisorImport/NSVPX_Import_XS_v1_1.ps1: -------------------------------------------------------------------------------- 1 | <# 2 | .SYNOPSIS 3 | Citrix NetScaler VPX import script for ESX. 4 | .DESCRIPTION 5 | Citrix NetScaler VPX import script for ESX importing the virtual appliance with a fixed IP. 6 | .NOTES 7 | Version: 1.1 8 | Author: Esther Barthel, MSc 9 | Creation Date: 2015-11-15 10 | 11 | Copyright (c) cognition IT. All rights reserved. 12 | 13 | Requires a local installation of the XenServer PowerShell Module (SDK) 14 | 15 | Based upon CTX article: http://support.citrix.com/article/CTX128236 16 | #> 17 | 18 | # Import XenServer 6.5.1 SDK 19 | Import-Module "C:\Install\XenServerPSModule" 20 | 21 | # Configure script variables 22 | $XSServer = "192.168.10.51" # Hostname or IP-address of XenServer Poolmaster 23 | $sourcePath = "C:\Install\NSVPX-XEN-11.0-63.16_nc.xva" # location of NS VPX image on machine running PowerShell 24 | $nsIPAddress = "192.168.10.6" # fixed IP-address to configure for the NetScaler VPX 25 | $nsNetmask = "255.255.255.0" # Netmask to configure for the NetScaler VPX 26 | $nsGateway = "192.168.10.1" # Default Gateway to configure for the NetScaler VPX 27 | $XSHost = "HLXS01" # The XenServer Host the VM is started on 28 | $VMName = "NSNitro" # The new name of the VM 29 | $VMMACAddress = "1e:71:8a:76:f1:6e" # The new MAC Address to be given to the VM 1e718a76f16e 30 | $Networklabel = "Storage Network 10 (NIC1)" 31 | 32 | # Open a connection to XenServer (poolmaster) and make it the default session (required) 33 | $oXSSession = Connect-XenServer -Server $XSServer -SetDefaultSession 34 | 35 | # Import the NetScaler image to the default SR 36 | Import-XenVm -XenHost $XSServer -Path $sourcePath -Verbose 37 | 38 | # Get the imported NS VPX VM uuid by it's default name 39 | $oVM = Get-XenVM -Name "NetScaler Virtual Appliance" 40 | 41 | # Change the MAC address of the VM if a MAC address was specified 42 | If (!(($VMMACaddress -eq $null) -or ($VMMACaddress -eq ""))) 43 | { 44 | # Retrieve the current VIF object from the specified VM object 45 | $oVIF = Get-XenVIF | Where-Object {$_.VM -eq $oVM} 46 | # Retrieve the Network object from the specified Network label 47 | $oNetwork = Get-XenNetwork -Name $Networklabel 48 | # Remove the automatically assigned VIF 49 | Remove-XenVIF -VIF $oVIF 50 | # Create a new VIF for the give Network and VM objects with a specified MAC Address 51 | New-XenVIF -VM $oVM -Network $oNetwork -MAC $VMMACAddress -Device "1" 52 | } 53 | 54 | # Change the name of the VM and make it start on the specified XS Host 55 | $oXS = Get-XenHost -Name $XSHost 56 | Set-XenVM -Uuid $oVM.uuid -NameLabel $VMName -Affinity $oXS 57 | 58 | # Get current VM XenStoreData values 59 | $newHash = $oVM.xenstore_data 60 | 61 | # Add required values for fixed IP settings for the NetScaler VPX 62 | $newHash.add("vm-data/ip",$nsIPAddress) 63 | $newHash.add("vm-data/netmask",$nsNetmask) 64 | $newHash.add("vm-data/gateway",$nsGateway) 65 | 66 | # Add new values to current VM XenStoreData (works only once, before NS is booted) 67 | Set-XenVM -VM $oVM -XenstoreData $newHash 68 | 69 | # Start the NS Appliance 70 | Invoke-XenVM $oVM -XenAction Start 71 | 72 | # Disconnect the session 73 | Get-XenSession -Server $XSServer | Disconnect-XenServer 74 | --------------------------------------------------------------------------------