stoevm Tracker

Re: Remote plugin sample Websocket not working

stoevm — Thu, 16 Nov 2023 10:05:51 GMT

Hi, Thank you for catching this bug.

I managed to reproduce the issue. It is not a constant bug so it was interesting task to find out the problem.
Before I give the explanation what goes wrong, just wanted to say that the WS should go through the proxied url as well.

Problem:

What is the current workflow:

1) A request is sent to the java code to generate a secure token. (ref: messaging-service.ts, WebSocketSessionTicketService)
2) Then the UI uses this token when creating WS (ref: messaging-service.ts)
3) The java code checks if this is the token that was previously generated. (ref WebSocketSessionTicketService::validateTicket)

The problem is at step 2 where the token sent from the UI is not encoded and the app tries to encode it (for example changing + to a space character which breaks the workflow).

This can be solved by encoding the token before passing it to the WebSocket.

The solution should be done in the messaging-service.ts by encoding the sessionTicket before sending it to the backend with the WS.
Since the WebSocket JS API does not allow header modification, this might be the only way to fix this from the JS side. Possible solution is to do the needed encoding transformations during ticket generation but requires much more coding.

Example fix:

const anchorElement = document.createElement('a');
anchorElement.href = 'messaging' +
      `?session-ticket=${encodeURIComponent(sessionTicket)}`;  // HERE IS THE FIX

const messagingUrl =
      `wss://${anchorElement.host}${anchorElement.pathname}${anchorElement.search}`;

Try out this fix to verify if it fixes the issue that you are observing.

Thanks,
Martin

vSphere Client SDK 8.0 U2 release

stoevm — Tue, 26 Sep 2023 15:26:55 GMT

Hi all,

A vSphere Client SDK has been release for the vSphere 8.0 U2 release.
The U2 vSphere Client SDK and release notes can be found on https://developer.vmware.com/web/sdk/8.0/client

VMware Explore Las Vegas Hackathon

stoevm — Fri, 28 Jul 2023 07:51:02 GMT

Hi all,

Our team will participate in this year's VMware Explore in Las Vegas with one session and a project in the Hackathon.

The session subject is: Journey to Develop, Install and Manage a vSphere Client Plug-In.

The hackathon project is open for others to join. Our project is focused on remote plugins and some new technologies to do analytics on the vCenter objects, titled: Optimising vSphere performance made easy

You can use the registration form to sign for this awesome hackathon project.

See you at the VMware Explore!

Re: Re:Unable to get serverGuid in vsphere-ui plugin 6.7

stoevm — Fri, 12 May 2023 10:03:29 GMT

Hi kumargandhi

With the new forwarding feature implemented in the SDK you do not even need the correct API endpoint in the UI.
All you need is the target VC for which the call is intended.

The clone-ticket can be send to any VC in the linked environment, and it will be forwarded to the VC from which vSphere Client the plugin is used. (this feature works for VCs >= 7.0u2 version)
More information on this can be found in the vsphere client docs:
https://vdc-download.vmware.com/vmwb-repository/dcr-public/009a36e4-2f17-46fc-ac27-ea9f8bf8c923/9988800b-a054-42d0-ae61-18f0ceafff24/vSphereClientSDK-801.pdf
Section: How to Delegate Session Authority to the Plug-in Server

If your plugin is to work after 7.0u2 you can take advantage of this new feature. Otherwise before 7.0u2 the plugin needs to trust all vCenters in the linked environment and use the getApiEndpoint.

The getApiEndpoint is not dependent on the linked environment, basically the guid is the one which determines for which VC the vsphere client will clone the session. This means that the api-endpoint is the same no matter for which VC you need a cloned ticket.

Again it is best to use the new functionality which eliminates the need for the getApiEndpoint API call.

Re: Remote Plugin Development: SOAP CloneSession() call returns session is not authenticated.

stoevm — Tue, 21 Mar 2023 11:19:59 GMT

A solution using the pyvmomi has been shown in the vSphere Client SDK forums from vedaniks,
https://communities.vmware.com/t5/vSphere-Client-SDK-Discussions/Clone-Session-using-Python/m-p/2926635#M6100

Re: Unable to clone ticket using /api/ui/vcenter/session/clone-ticket

stoevm — Wed, 31 Aug 2022 11:33:15 GMT

Hi vedaniks,

On a global view you can not fetch the vc_guid, because there are corner cases where this results in an undefined behavior. For example one remote plugin instance registered on multiple vCenters. At this point there will be multiple guids for that global view.

The idea for remote plugins is to have the guids of the registered vCenters configured during plugin installation, for example in a conf file or through some REST endpoints.

This way the plugin will know to which vCenters it is supposed to be talking to and the plugin UI will not be required to retrieve such information. This is the case for global views since there is no object and the plugin ( if it wants to retrieve info from the vCenters) can do it through the configured vCenter guids (thumbprints and so on...) .

For a context object it is important to retrieve the object and the guid since you want(in most cases) to show information relevant only for that vCenter ( and object ).

Re: CloneSession() throws "Login failed because the session could not be re-registered"

stoevm — Tue, 02 Aug 2022 14:30:53 GMT

Moving this to the vSphere SDK for Perl Discussions for better resolution.

Re: Vmware ESXi

stoevm — Thu, 07 Jul 2022 13:28:32 GMT

Hi ITTech7,

This forum is for vSphere Client SDK plugins related questions, please use the general vSphere forum to post your question.

Thanks,
Martin

Re: vcenter 7.0 U2 vs vcenter 6.7 U3 sandbox for remote client plugins

stoevm — Wed, 20 Apr 2022 11:08:30 GMT

Hi harsha219,

I checked and unfortunately we no longer have a mechanism to release such changes in the 6.7 release cycle.

Martin.

Re: vcenter 7.0 U2 vs vcenter 6.7 U3 sandbox for remote client plugins

stoevm — Mon, 04 Apr 2022 11:16:34 GMT

Let me check if it is possible to add such a feature for an upcoming patch for version 6.7U3.
I will update you once I have the details.

Thanks

Re: vcenter 7.0 U2 vs vcenter 6.7 U3 sandbox for remote client plugins

stoevm — Mon, 04 Apr 2022 10:54:35 GMT

For local plugins it works because they do not have the sandbox attribute attached to their iframe.
When you open developers console when observing one of your plugins view in the vSphere Client and look at the iframe encapsulating your plugin, you will see that local and remote plugins are encapsulated with a different iframe element.
https://www.w3schools.com/tags/att_iframe_sandbox.asp

For local plugins there are no restrictions in the iframe sandbox rules, because a lot of plugins would simply not work, however this creates possible security flaws.

For remote plugins the security is the main concern, thus not all sandbox attributes are allowed, we started with a minimal set in 6.7U3 (which for example does not contain allow-popups), after some requests from plugin writers we have added it and it is present in the 7.0U2 as you mentioned).

It is not clear to me, if you have developed a local plugin working as expected for 6.7U3, why would you develop the remote plugin to cover those versions as well ?

Re: vcenter 7.0 U2 vs vcenter 6.7 U3 sandbox for remote client plugins

stoevm — Mon, 04 Apr 2022 07:23:07 GMT

Hi harsha,

The allow-popups is not allowed in 6.7U3, there is no such implementation, it was added post-factum.
There is no way to enable it, since the implementation is missing.

About the suggestions, can you elaborate more on what is the use-case that you try to accomplish ?
Most use-cases can be migrated from popups to opening a modal and in most cases this is the best practice. However it depends on the use-case in question.

Re: How to get vm certificate expiration dates with vsphere api

stoevm — Mon, 28 Feb 2022 11:40:41 GMT

Hi spsrs,

This a domain specific question and not related to the vSphere Client SDK.

Please post this question in the vSphere Management SDK forum.

Re: How to collect Cluster Health with Rest API

stoevm — Mon, 28 Feb 2022 11:40:35 GMT

Hi spsrs,

This a domain specific question and not related to the vSphere Client SDK.

Please post this question in the vSphere Management SDK forum.

Re: Cannot find the remote plugin programming guide for 7.0 anymore

stoevm — Mon, 28 Feb 2022 11:27:11 GMT

Hi rajagopalans,

I managed to fix the link to point to the correct URI.

Thanks for bringing this up.

Martin

Re: Unable to clone ticket using /api/ui/vcenter/session/clone-ticket

stoevm — Mon, 28 Feb 2022 10:15:58 GMT

Hi vedaniks

The whole result returned from the getSessionInfo should be used as shown in the code snippet.

Logs should be available in the /storage/log/vmware/vsphere-ui/logs/vsphere_client_virgo.log.

Please locate the error log why 401 is thrown and post it.

Thanks,
Martin

Re: Unable to deploy sample remote plugin for the vSphere Client (plugin does not appear in vSphere

stoevm — Mon, 28 Feb 2022 10:03:16 GMT

Hi puneeth-sai

The thumbprint must be in a colon separated format.
Namely the thumbprint that you provided

555db10de0333e10ab1ef4866261f07f93fef69b

should look like this

55:5D:B1:0D:E0:33:3E:10:AB:1E:F4:86:62:61:F0:7F:93:FE:F6:9B

Re: amldump for UEFI table

stoevm — Fri, 03 Dec 2021 11:57:31 GMT

Hi,

This forum is for the vSphere Client SDK and UI plugins.

Please try the vSphere-Management SDK forum for this kind of questions.

Cheers,

Martin

Re: Automated scheduled power off/ on

stoevm — Fri, 03 Dec 2021 11:54:12 GMT

Hi,

Do you want to schedule VM power off and on in your plugin code ?

Just a note that this forum is for the vSphere Client SDK and UI plugins.

Please try the vSphere-Management SDK forum for this kind of questions.

Cheers,

Martin

Re: vSphere 7.0U3 UI regressions for custom objects

stoevm — Wed, 17 Nov 2021 09:32:29 GMT

Hi Chris,

The fix did not get into the 7.0U3 release cycle.
I can say for sure that it will be included in the next non-patch release.

Sorry for the inconvenience that this bug introduced,
Martin