topic Re: Applying NSXT Tag to a VM in VMware PowerCLI Discussions

Applying NSXT Tag to a VM

pamiller21 — Wed, 11 Aug 2021 19:33:05 GMT

I am switching over to NSXT from V and trying to figure out how to convert my script to apply NSXT Tags to new VMs being built. Any help would be appreciated

Re: Applying NSXT Tag to a VM

LucD — Wed, 11 Aug 2021 20:02:16 GMT

Have you seen Add NSX-T Tags To Virtual Machines with PowerShell

Re: Applying NSXT Tag to a VM

pamiller21 — Wed, 11 Aug 2021 20:35:00 GMT

I did not, my google-fu failed to find it. I am doing some testing and missing something. This seems to be used to apply a tag to nearly a full cluster I am trying to figure out how to filter it down to a single VM.

#############################
# Connect to vCenter #
#############################
Import-Module -Name VMware.PowerCLI
Set-PowerCLIConfiguration -DisplayDeprecationWarnings $false -InvalidCertificateAction ignore -confirm:$false
$vc = 'URL'
$Cred = Import-Clixml /home/scripts/creds/creds.xml

Connect-VIServer $VC -Credential $Cred

#############################
# Connect to NSX-T #
#############################
Import-Module -Name VMware.PowerCLI
Import-Module PowerNSX
Set-PowerCLIConfiguration -DisplayDeprecationWarnings $false -InvalidCertificateAction ignore -confirm:$false
$NSXCred = Import-Clixml /home/scripts/creds/nsxt.xml
$skipcertcheck = $true
$AuthMethod = “Basic”
$NSXMgr = ”URL”
$policyapi = "/policy/api/v1"
$base_url = ( "https://" + $NSXMgr + $policyapi )
$posturl = "https://$NSXMgr/api/v1/fabric/virtual-machines?action=update_tags"

$NSXTag = 'TAG'
$vm = 'SINGLE VM'
$vms = Get-VM $vm | ForEach-Object { $_ | Get-View }

foreach ($vm in $vms) {
$vmid = $vm.Config.InstanceUuid }

$geturl = "https://$NSXMgr/api/v1/fabric/virtual-machines?external_id=$vmid&included_fields=tags"
$getrequest = Invoke-RestMethod -Uri $geturl -Authentication Basic -Credential $nsxcred -Method Get -ContentType "application/json" -SkipCertificateCheck
$getresult = $getrequest.results | ConvertTo-Json -Compress
$currenttags = [regex]::match($getresult,'\[([^\)]+)\]').Groups[1].Value

$JSON = @"
{"external_id":"$vmid","tags": [{"scope":"$newscope","tag":"$NSXTag"},$currenttags]}
"@

Invoke-RestMethod -Uri $posturl -Authentication Basic -Credential $NSXCred -Method Post -Body $JSON -ContentType "application/json" -SkipCertificateCheck

Re: Applying NSXT Tag to a VM

LucD — Wed, 11 Aug 2021 20:45:22 GMT

I think the script is for a single VM, the $vm = 'SINGLE VM' line seems to indicate that.

Re: Applying NSXT Tag to a VM

pamiller21 — Wed, 11 Aug 2021 20:47:38 GMT

What I pasted there was my mangled transformation of the site's script. It doesn't seem to apply a tag to that single vm or do anything. Not sure how to make it do that.

Re: Applying NSXT Tag to a VM

Zsoldier — Wed, 11 Aug 2021 20:58:32 GMT

You need to define $newscope variable is what it looks like.

Re: Applying NSXT Tag to a VM

pamiller21 — Wed, 11 Aug 2021 21:00:25 GMT

Somewhere that said it was optional, I don't have a scoped defined on my tag either so not sure what to put.

Re: Applying NSXT Tag to a VM

Zsoldier — Wed, 11 Aug 2021 21:21:04 GMT

Scope can be anything really. There are also other methods of tag updates available depending on version you are working against. Which NSX-T version are you using? 3.1.2 gives you more options outside of just update tag to simplify your scripting too. 2.5.x limits to just update.

https://vdc-download.vmware.com/vmwb-repository/dcr-public/d6de7a5e-636f-4677-8dbd-6f4ba91fa5e0/36b4881c-41cd-4c46-81d1-b2ca3a6c693b/api_includes/system_administration_configuration_fabric_inventory_virtual_machines.html

Re: Applying NSXT Tag to a VM

pamiller21 — Fri, 13 Aug 2021 14:11:35 GMT

I am running 3.1.2, so can I put in any random keyword in the scope field?

Re: Applying NSXT Tag to a VM

pamiller21 — Mon, 16 Aug 2021 03:25:43 GMT

@LucD When I run the code you sent I get this error:

ERROR:

Invoke-RestMethod: {
"httpStatus" : "BAD_REQUEST",
"error_code" : 220,
"module_name" : "common-services",
"error_message" : "Unexpected character (']' (code 93)): expected a value"

CODE:

Connect-VIServer $VC -Credential $Cred

$NSXTag = 'TAG'
$vmName = 'SINGLE VM'
$vm = Get-VM -Name $vmName

$vmid = $vm.ExtensionData.Config.InstanceUuid

$JSON = @"
{"external_id":"$vmid","tags": [{"scope":"$newscope","tag":"$NSXTag"},$currenttags]}
"@

Invoke-RestMethod -Uri $posturl -Authentication Basic -Credential $NSXCred -Method Post -Body $JSON -ContentType "application/json" -SkipCertificateCheck

Re: Applying NSXT Tag to a VM

Zsoldier — Mon, 16 Aug 2021 17:39:25 GMT

Basically means malformed json. Here is script cleaned up a bit.

#Requires -Module vmware.powercli $Credential = Get-Credential $skipcertcheck = $true $AuthMethod = “Basic” $NSXMgr=”0.0.0.0” $apiendpoint = "/api/v1/fabric" $base_url = ("https://" + $NSXMgr + $apiendpoint) $tag = "Naka" $scope = "NakaScope" $vms = Get-VM -Name nakabuntu | Get-View -Property "Config" # Add Tags to existing tags (Valid for NSX-T 3.1.2, previous versions only have update_tag) $endpoint = "/virtual-machines" $action = "add_tags" Foreach ($vm in $vms) { $vmid = $vm.Config.InstanceUuid $JSON = " { `"external_id`":`"$vmid`", `"tags`": [ { `"scope`":`"$scope`", `"tag`":`"$Tag`" } ] } " $Data = Invoke-restmethod -Uri ($base_url + $EndPoint + "?action=" + $action) -Method POST -Body $JSON -ContentType 'application/json' -Credential $Credential -SkipCertificateCheck:$skipcertcheck -Authentication:$AuthMethod }

Re: Applying NSXT Tag to a VM

pamiller21 — Fri, 20 Aug 2021 03:27:37 GMT

I ran that code and it didn't give me any errors, but also didn't do the tag. Any idea what I can check into now?

Re: Applying NSXT Tag to a VM

Zsoldier — Fri, 20 Aug 2021 12:32:48 GMT

Did you change the get-vm filter?

Re: Applying NSXT Tag to a VM

pamiller21 — Fri, 20 Aug 2021 13:08:58 GMT

Ya I updated it to a variable and set the variable earlier, here is exactly what I tried:

#############################
# Connect to vCenter #
#############################
Import-Module -Name VMware.PowerCLI
Set-PowerCLIConfiguration -DisplayDeprecationWarnings $false -InvalidCertificateAction ignore -confirm:$false
$vc = 'vcsa.ruralnex.com'
$Cred = Import-Clixml /home/scripts/creds/creds.xml

Connect-VIServer $VC -Credential $Cred

#############################
# Connect to NSX-T #
#############################
Import-Module -Name VMware.PowerCLI
Import-Module PowerNSX
Set-PowerCLIConfiguration -DisplayDeprecationWarnings $false -InvalidCertificateAction ignore -confirm:$false
$NSXCred = Import-Clixml /home/scripts/creds/nsxt.xml
$skipcertcheck = $true
$AuthMethod = “Basic”
$NSXMgr = ”URL”
$policyapi = "/policy/api/v1"
#$base_url = ( "https://" + $NSXMgr + $policyapi )
$base_url = ("https://" + $NSXMgr + $apiendpoint)
$posturl = "https://$NSXMgr/api/v1/fabric/virtual-machines?action=update_tags"

$NSXTag = 'Alerta'
$vmName = 'alerta03_replica'
$vm = Get-VM -Name $vmName

##Requires -Module vmware.powercli
#$Credential = Get-Credential
#$skipcertcheck = $true
#$AuthMethod = “Basic”
#$NSXMgr=”0.0.0.0”
#$apiendpoint = "/api/v1/fabric"

#$tag = "Naka"
$scope = "Servers"

$vms = Get-VM -Name $vmName | Get-View -Property "Config"
# Add Tags to existing tags (Valid for NSX-T 3.1.2, previous versions only have update_tag)
$endpoint = "/virtual-machines"
$action = "add_tags"
Foreach ($vm in $vms)
{
$vmid = $vm.Config.InstanceUuid
$JSON = "
{
`"external_id`":`"$vmid`",
`"tags`": [
{
# `"scope`":`"$scope`",
`"tag`":`"$NSXTag`"
}
]
}
"

$Data = Invoke-restmethod -Uri ($base_url + $EndPoint + "?action=" + $action) -Method POST -Body $JSON -ContentType 'application/json' -Credential $NSXCred -SkipCertificateCheck:$skipcertcheck -Authentication:$AuthMethod
}

Re: Applying NSXT Tag to a VM

Zsoldier — Fri, 20 Aug 2021 14:17:36 GMT

Have you tried running the code I posted above verbatim? There are lots of problems w/ the way that you've modified your script. $apiendpoint is not defined correctly since you've commented it out and is not before you capture your base_url. Commenting out scope doesn't work the way you've done here. I've cleaned up my script example further so you can omit scope if you don't need it and change the get-vm call to base on a vmnamefilter variable.

Also, you do not need to import the PowerNSX module unless you are making additional calls to an NSX-V instance in the same script.

#Requires -Module vmware.powercli $Credential = Get-Credential $skipcertcheck = $true $AuthMethod = “Basic” $NSXMgr=”0.0.0.0” $apiendpoint = "/api/v1/fabric" $base_url = ("https://" + $NSXMgr + $apiendpoint) $tag = "Naka" $scope = "NakaScope" # If scope not required, simply define as $null or "" $vmnamefilter = "nakabuntu" # Not required. Will loop through all VM's otherwise. $vms = Get-VM $vmnamefilter | Get-View -Property "Config" # Add Tags to existing tags (Valid for NSX-T 3.1.2, previous versions only have update_tag) $endpoint = "/virtual-machines" $action = "add_tags" Foreach ($vm in $vms) { $vmid = $vm.Config.InstanceUuid If ([string]::IsNullOrWhiteSpace($Scope)){ $JSON = " { `"external_id`":`"$vmid`", `"tags`": [ { `"tag`":`"$Tag`" } ] } " } Else{ $JSON = " { `"external_id`":`"$vmid`", `"tags`": [ { `"scope`":`"$scope`", `"tag`":`"$Tag`" } ] } " } $Data = Invoke-restmethod -Uri ($base_url + $EndPoint + "?action=" + $action) -Method POST -Body $JSON -ContentType 'application/json' -Credential $Credential -SkipCertificateCheck:$skipcertcheck -Authentication:$AuthMethod }

Re: Applying NSXT Tag to a VM

pamiller21 — Fri, 20 Aug 2021 16:20:27 GMT

Thank you very much for this, sorry I goofed up the script the first time.

Re: Applying NSXT Tag to a VM

cvv2 — Mon, 20 Sep 2021 13:32:46 GMT

Thank you, with a few tweaks my rollout script worked the way I want again.

Re: Applying NSXT Tag to a VM

vespavbb — Thu, 15 Sep 2022 09:15:48 GMT

Hi,

I´m just trying to use this script, but I´m not able to connect to nsx via invoke-restmethod. I use the complete script...

$Data = Invoke-restmethod -Uri ($base_url + $EndPoint + "?action=" + $action) -Method POST -Body $JSON -ContentType 'application/json' -Credential $Credential -SkipCertificateCheck:$skipcertcheck -Authentication:$AuthMethod

Invoke-RestMethod : A parameter cannot be found that matches parameter name 'SkipCertificateCheck'.
At line:1 char:164
+ ... lication/json' -Credential $Credential -SkipCertificateCheck:$skipcer ...
+ ~~~~~~~~~~~~~~~~~~~~~~
+ CategoryInfo : InvalidArgument: (:) [Invoke-RestMethod], ParameterBindingException
+ FullyQualifiedErrorId : NamedParameterNotFound,Microsoft.PowerShell.Commands.InvokeRestMethodCommand

Re: Applying NSXT Tag to a VM

Zsoldier — Tue, 11 Oct 2022 16:25:49 GMT

SkipCertificateCheck is only available via Powershell Core I believe.

Re: Applying NSXT Tag to a VM

LucD — Tue, 11 Oct 2022 17:50:25 GMT

That is correct