doskiran Tracker

Re: The class vim.vm.GuestInfo is not giving primary IPAddress of Virtual Machine

doskiran — Fri, 03 Nov 2023 10:38:30 GMT

Sample program to print the Virtual machine network details(Nic name, IPv4, Mac, Nic Key, Portgroup) using VI java API(vSphere Management SDK). - PrintVMNetworkDetails.java
Output:

Network Adatpter     IP4Address         Mac                  Key      Portgroup                                                                                         
----------------     ----------         ---                  ---      ---------                                                                                       
Network adapter 1    10.10.10.6         00:15:23:31:c9:22    4000     VM Network                                                                                       
Network adapter 2    10.20.20.7         07:89:61:14:38:66    4001     dvPortgroup

Ipaddesses of each vNIC:

GuestNicInfo[] nicArr = vm.getGuest().getNet(); for (GuestNicInfo nic : nicArr) { NetIpConfigInfoIpAddress[] netIpArr = nic.getIpConfig().getIpAddress(); for (NetIpConfigInfoIpAddress netIp : netIpArr) { System.out.println("Ipaddress::" + netIp.getIpAddress()); } }

Re: VIM25.jar Support Java17

doskiran — Mon, 07 Aug 2023 10:19:37 GMT

Hi @VinothCM ,

Which version of SDK(vSphere Management SDK) you are using? Also, share the steps followed to reproduce this issue?

Because vim25.jar is generated from 1.8 java, and it should work with the LTS version of Java. (8/11/17).

- Kiran

Re: get DRS rule conflicts in cluster using web services api

doskiran — Fri, 04 Aug 2023 06:05:39 GMT

When we create Anti-Affinity and then Affinity Rule for the same VMs. The Affinity rule should become invalid(enabled = false)

i.e. Anti-Affinity conflicting with Affinity Rule.

API to get the status:

ClusterComputeResource -> ClusterConfigInfo -> ClusterRuleInfo -> isEnabled()

eg:

boolean status = ruleInfo[1].getInfo().isEnabled();

Data Object - ClusterRuleInfo(vim.cluster.RuleInfo)

enabled (boolean) ==> Flag to indicate whether or not the rule is enabled. Set this property when you configure the rule. The default value is false (disabled). If there is a rule conflict, the Server can override the setting to disable a rule.

Re: Rest api register active directory user

doskiran — Fri, 04 Aug 2023 04:58:42 GMT

Make sure to add idm_protocol and server_endpoints ( in active_directory_over_ldap)
eg:

"idm_protocol": "LDAP"

and

"server_endpoints": [ "ldap://<server>:<port>" ]

Re: Retreive VM TAGs association via VMware SOAP API

doskiran — Mon, 10 Jul 2023 11:24:38 GMT

Use VMware common infrastructure services REST APIs( CIS APIs) for Tags.
APIs to create, manage, and enumerate tags & categories also query the attached tags and attached objects.

Ref: https://developer.vmware.com/apis/vsphere-automation/latest/cis/tagging/tag_association/

Re: We were getting the below error in the API calls

doskiran — Wed, 12 Jul 2023 15:14:07 GMT

Hi @ appsysadmin,

What is the API used and parameters passed? And what is the vCenter version?

Also refer this steps - https://communities.vmware.com/t5/VMware-code-Discussions/Unable-to-retrieve-performance-metric-for-a-vm/td-p/2971254

Re: Unable to retrieve performance metric for a vm

doskiran — Tue, 04 Jul 2023 16:34:16 GMT

Looks like Create Acq Spec is not created.
vStats collects data only for the configured AcqSpecs.

Try these steps:

1. Create AcqSpecs with POST Create AcqSpec API
POST: https://{api_host}/api/stats/acq-specs
Spec:

{ "counters": { "cid_mid": { "cid":"power.capacity.usage.VM" } }, "interval" :"30", "expiration":"10000000000", "resources": [ { "type":"VM", "id_value":"<vm-moid>", "predicate":"EQUAL" } ] }

2. Query Data Points Data:

GET: https://{api_host}/api/stats/data/dp?cid=power.capacity.usage.VM&types=VM

Re: How to get vm object using moref_id pyvmomi

doskiran — Thu, 23 Mar 2023 13:23:17 GMT

From my understanding, internally, Vim::get_view() also retrieves from the VM Inventory view list.

Eg: Same code in PyVmomi to get VM object using vm_moid

# vm_morref: "vm-xx" or "vim.VirtualMachine:vm-xx"

def getVMFromMOR(si, vm_moref): vm_obj = None view_ref = si.content.viewManager.CreateContainerView(container=si.content.rootFolder, type=[pyVmomi.vim.VirtualMachine], recursive=True) for managed_object_ref in view_ref.view: if vm_moref in str(managed_object_ref): vm_obj = managed_object_ref break return vm_obj

Re: Set type of hard disk for virtual machine

doskiran — Thu, 23 Mar 2023 16:17:05 GMT

AFAIK, not all VM operations-based vSphere REST APIs are available in current releases. We may expect it in the next major vSphere release. But in SOAP APIs (vSphere Management APIs), have the option to set the disk provisioning type of a hard disk.

Sample code:
Add new harddisk with specified capacity and disk provisioning type for a VM:
https://developer.vmware.com/samples/1820/add-new-harddisk-with-specified-capacity-and-disk-provisioning-type-for-a-vm?h=Sample#code

Re: Api Sessions

doskiran — Fri, 17 Mar 2023 05:47:23 GMT

Use vSphere SOAP-based (vSphere Management SDK) APIs to get the API sessions.

API: SessionManager

sessionList*

UserSession[]

The list of currently active sessions.

To get your API sessions, compare the client machine's IP address and application name with the IpAddress and UserAgent of the UserSession object.

Sample code:

public void printUserSessions(String vCenterServer, String userName, String password) { try { si = new ServiceInstance(new URL("https://" + vCenterServer + "/sdk"), userName, password, false); SessionManager sm = si.getSessionManager(); UserSession[] usList = sm.getSessionList(); for (UserSession us : usList) { System.out.println("Client IPAddress::" + us.getIpAddress()); System.out.println("Session Username::" + us.getUserName()); System.out.println("Application/UserAgent::" + us.getUserAgent()); System.out.println("--------------------------------------------------"); } } catch (Exception e) { System.err.println("Error ServiceInstance::" + e.getLocalizedMessage()); } }

Re: how to configure ssl on system so that i can use ssl option pyvmomi or python vshpere sdk 8.0

doskiran — Mon, 20 Feb 2023 06:41:32 GMT

The same vCenter cert works for both VC/ESXi sessions.
One common way to download cert is - Click on the cert in your browser (in chrome it's to the right of the address, says "Not secure") then click the certification path, and click "CA" to export it into a crt file.

Re: how to configure ssl on system so that i can use ssl option pyvmomi or python vshpere sdk 8.0

doskiran — Fri, 17 Feb 2023 12:18:00 GMT

Steps for Linux:
-------------------
1) Download the crt file from vCenter.
i.e,
Go to https://vCenter in your browser and press Enter.
At the bottom right of the page, there is an option to "Download trusted root CA certificates."
It will download the zip file, extract it, and then navigate to the "lin" folder, where it has the certificate file (i.e., "XXXXXXXX.0").

2) Copy the cert file and save it in the "/etc/ssl/certs" folder on your client machine.

3) Add the vCenter IPaddress and hostname entry in the /etc/hosts file. ( if any DNS resolution issue)

4) Run the Python program, but make sure to pass the vCenter hostname (FQDN) instead of the IP address in the code or command.
Eg: without any ssl context

from pyVim.connect import SmartConnect si = SmartConnect(host="<vCenter or ESXi hostname>", user="<username>", pwd='<password>', port=443)

Re: SOAP call in xml to remove NFS mount

doskiran — Wed, 15 Feb 2023 13:37:02 GMT

Pass the ManagedObjectReference(MOID) for both HostDatastoreSystem and Datastore( not the datastore name).

https://vdc-repo.vmware.com/vmwb-repository/dcr-public/1ef6c336-7bef-477d-b9bb-caa1767d7e30/82521f49-9d9a-42b7-b19b-9e6cd9b30db1/vim.host.DatastoreSystem.html#removeDatastore

Eg:

<soap:Envelope xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <RemoveDatastore xmlns="urn:internalvim25"> <_this xsi:type="HostDatastoreSystem" type="HostDatastoreSystem">datastoreSystem-200</_this> <datastore xsi:type="Datastore">datastore-20</datastore> </RemoveDatastore> </soap:Body> </soap:Envelope>

Re: Does vsphere-automation-sdk-python require vddk

doskiran — Mon, 13 Feb 2023 08:40:19 GMT

vSphere Automation SDK works only with vCenter sessions.

Because there are no public APIs for ESXi VMODL2.

Hence pass vCenter credentials in the command.

To run with ESXi credentials, use vSphere management SDKs .
i.e,

pyVmomi(SOAP based) allows you to manage VMware ESXi and vCenter using Python.

pyVmomi: https://github.com/vmware/pyvmomi

Re: what is the equivalent python sdk module for perl sdk module " Vim::find_entity_view()

doskiran — Mon, 13 Feb 2023 08:35:37 GMT

The equivalent python sdk module for perl sdk module is pyVmomi.

Both perl and pyVmomi are SOAP based APIs.

pyVmomi allows you to manage VMware ESXi and vCenter using Python.

pyVmomi: https://github.com/vmware/pyvmomi

Re: Getting error while listing all vms under ESXi 7.0 using python vsphere sdk 8.0

doskiran — Mon, 13 Feb 2023 08:30:17 GMT

vSphere Automation SDK works only with vCenter sessions.

Because there are no public APIs for ESXi VMODL2.

To achieve your task use pyVmomi.
> pyVmomi(SOAP based) allows you to manage VMware ESXi and vCenter using Python.

pyVmomi: https://github.com/vmware/pyvmomi

Note: Mentioned perl SDK is also a SOAP-based( vSphere Web Services API) integration point for the vSphere Management SDK.

Sample program to list all VMs under ESXi/vCenter:

from pyVim.connect import SmartConnect import ssl s = ssl.create_default_context(purpose=ssl.Purpose.CLIENT_AUTH) s.verify_mode = ssl.CERT_NONE si = SmartConnect( host="<vCenter or ESXi server>", user="root", pwd="<passw0rd>", port=443, sslContext=s, ) content = si.RetrieveContent() for child in content.rootFolder.childEntity: if hasattr(child, "vmFolder"): datacenter = child vmFolder = datacenter.vmFolder vmList = vmFolder.childEntity for vm in vmList: summary = vm.summary print("VM Name: ", summary.config.name)

Re: Esxi Webservice Login Not Working

doskiran — Tue, 31 Jan 2023 10:37:02 GMT

The issue is not passing the right SessionManager value in tag <urn:_this type="SessionManager"> .

To retrieve the SessionManager value, use the below POST SOAP API with the body and then pass the retrieved SessionManager value in the login API.

Step#1:

POST: https://<server>/sdk

Body:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:vim25"> <soapenv:Header /> <soapenv:Body> <urn:RetrieveServiceContent> <urn:_this type="ServiceInstance">ServiceInstance</urn:_this> </urn:RetrieveServiceContent> </soapenv:Body> </soapenv:Envelope>

Response:

<?xml version="1.0" encoding="UTF-8"?> <soapenv:Envelope xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/"...> <soapenv:Body> <RetrieveServiceContentResponse xmlns="urn:vim25"> ... <about> .... </about> ... <sessionManager type="SessionManager">ha-sessionmgr</sessionManager> ... </returnval> </RetrieveServiceContentResponse> </soapenv:Body> </soapenv:Envelope>

Step#2: Copy the above SessionManager value i.e, "ha-sessionmgr" and update in login api.

POST: https://<server>/sdk

BODY:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:vim25"> <soapenv:Header /> <soapenv:Body> <urn:Login> <urn:_this type="SessionManager">ha-sessionmgr</urn:_this> <urn:userName>root</urn:userName> <urn:password>XXXXXXXX</urn:password> <urn:locale></urn:locale> </urn:Login> </soapenv:Body> </soapenv:Envelope>

Response:

<?xml version="1.0" encoding="UTF-8"?> <soapenv:Envelope xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <soapenv:Body> <LoginResponse xmlns="urn:vim25"> <returnval> <key>xxxxxxxx-xxxx-xxxx-xxxxx-xxxxxxxxxxxx</key> <userName>root</userName> <fullName>Administrator</fullName> <loginTime>2023-01-31T09:06:39.124597Z</loginTime> <lastActiveTime>2023-01-31T09:06:39.124615Z</lastActiveTime> <locale>en</locale> <messageLocale>en</messageLocale> </returnval> </LoginResponse> </soapenv:Body> </soapenv:Envelope>

Re: Does vsphere-automation-sdk-python require vddk

doskiran — Mon, 23 Jan 2023 10:46:10 GMT

Add argument "--skipverification" at the end of the command.

--skipverification = It skips verifying server certificate when connecting to vc.

Eg:
> python3 ./samples/vsphere/vcenter/vm/list_vms.py -s x.x.x.x -u Administrator@vsphere.local -p xxxxx --skipverification

Re: Rest API to list port groups for a specific cluster?

doskiran — Sun, 08 Jan 2023 09:40:47 GMT

Not all vSphere REST APIs are available currently, we may expect them in the next vSphere major releases.

For now to achieve your task use SOAP-based APIs ( vSphere Management SDKs) :

Here is the java sample method using VI Java API: Getting started with vSphere API using VI Java

public void portgroupList(String vCenterIP, String username, String password, String clusterName) { Map<String, String> vssPGs = new HashMap<>(); Map<String, String> dvsPGs = new HashMap<>(); try { ServiceInstance serviceInstance = new ServiceInstance(new URL("https://" + vCenterIP + "/sdk"), username, password, true); ClusterComputeResource cls = (ClusterComputeResource) new InventoryNavigator( serviceInstance.getRootFolder()).searchManagedEntity("ClusterComputeResource", clusterName); HostSystem[] hsArr = cls.getHosts(); for (HostSystem hs : hsArr) { Network[] netArr = hs.getNetworks(); for (Network net : netArr) { if (net.getMOR().getType().equals("Network")) vssPGs.put(net.getName(), net.getMOR().getVal()); else if (net.getMOR().getType().equals("DistributedVirtualPortgroup")) dvsPGs.put(net.getName(), net.getMOR().getVal()); } } if (!vssPGs.isEmpty()) { System.out.println("Virtual Standard Switch portgroups in cluster::" + clusterName); vssPGs.forEach((k, v) -> { System.out.println(k + " = " + v); }); } if (!dvsPGs.isEmpty()) { System.out.println("Virtual Distributed Switch portgroups in cluster::" + clusterName); dvsPGs.forEach((k, v) -> { System.out.println(k + " = " + v); }); } } catch (Exception e) { System.err.println("Error::" + e.getLocalizedMessage()); } }

Re: Setting Security.PasswordQualityControl with esxcli

doskiran — Mon, 28 Nov 2022 10:37:00 GMT

I could see the option "/Security/PasswordQualityControl" is not available in esxcli/esxcfg-advcfg advanced settings list.

Eg:

> esxcli system settings advanced list | grep Path:

> esxcfg-advcfg -l

But we can update the advanced setting for "/Security/PasswordQualityControl" using vSphere PowerCLI or SOAP-based APIs or MOB..

PowerCLI:

$PasswordPolicy = "retry=3 min=disabled,disabled,disabled,12,8" $Host1 = Get-VMHost | Where { $_.Name -eq "<host-ip>" } $Host1 | Get-AdvancedSetting -Name "Security.PasswordQualityControl" | Set-AdvancedSetting -Value $PasswordPolicy -Confirm:$false

VI Java API:

ServiceInstance si = new ServiceInstance(new URL("https://" + vcIPaddress + "/sdk"), userName, password, true); HostSystem hs = (HostSystem) new InventoryNavigator(si.getRootFolder()).searchManagedEntity("HostSystem","<host-ip>"); OptionManager hom = hs.getOptionManager(); OptionValue[] ovArr = hom.getSetting(); String value = "retry=3 min=disabled,disabled,disabled,disabled,8"; for (OptionValue optionValue : ovArr) { if (optionValue.getKey().equals("Security.PasswordQualityControl")) { optionValue.setValue(value); hom.updateOptions(new OptionValue[] { optionValue }); break; } }