VMWare vCenter

the vmware vcenter connector allows for seamless integration with vmware's virtualization management platform, enabling automated interactions with virtual machines and their operating systems vmware vcenter is a centralized management platform for vmware vsphere environments, designed to simplify virtual infrastructure management this connector enables swimlane turbine users to automate key virtual machine operations such as retrieving guest identities, managing power states, and querying guest os processes by integrating with vmware vcenter, users can enhance their security automation workflows, ensuring efficient vm management and rapid response to security incidents within their virtualized environments prerequisites to effectively utilize the vmware vcenter connector with swimlane turbine, ensure you have the following prerequisites custom authentication with the following parameters url the endpoint url for the vmware vcenter api grant type the oauth grant type used for authorization subject token the subject token required for obtaining an access token subject token type the type of the subject token provided for authentication capabilities this connector provides the following capabilities get guest identity get guest power get vm pid processes list guest process reboot guest power shutdown guest power standby guest power vm get guest local filesystem vm get guest networking vm get guest operations notes https //developer broadcom com/xapis/vsphere automation api/latest/vcenter/authentication/ https //developer broadcom com/xapis/vsphere automation api/latest/vcenter/vm/ configurations vmware vcenter oauth authentication configuration parameters parameter description type required url a url to the target host string required grant type the grant type string required resource the resource string optional audience the audience string optional scope the scope string optional requested token type the requested token type string optional subject token the subject token string required subject token type the subject token type string required actor token the actor token string optional actor token type the actor token type string optional actions get guest identity retrieve detailed identity information for a specified virtual machine (vm) in vmware vcenter using the vm path parameter endpoint url /api/vcenter/vm/{{vm}}/guest/identity method get input argument name type required description path parameters vm string required virtual machine id the parameter must be an identifier for the resource type input example {"path parameters" {"vm" "vmware name"}} output parameter type description status code number http status code of the response reason string response reason phrase name string name of the resource family string output field family full name object name of the resource full name id string unique identifier full name default message string name of the resource full name args array name of the resource full name localized string name of the resource host name string name of the resource ip address string output field ip address output example {"status code" 200,"response headers" {},"reason" "ok","json body" {"name" "string","family" "string","full name" {"id" "string","default message" "string","args" \[],"localized" "string"},"host name" "string","ip address" "string"}} get guest power retrieve the power state of a guest operating system in vmware vcenter, requiring the virtual machine identifier endpoint url /api/vcenter/vm/{{vm}}/guest/power method get input argument name type required description path parameters vm string required virtual machine id the parameter must be an identifier for the resource type input example {"path parameters" {"vm" "vmware name"}} output parameter type description status code number http status code of the response reason string response reason phrase state string output field state operations ready boolean output field operations ready output example {"status code" 200,"response headers" {},"reason" "ok","json body" {"state" "string","operations ready"\ false}} get vm pid processes retrieve the status of processes running on a guest os in vmware vcenter, identified by vm and pid, using specified credentials endpoint url /api/vcenter/vm/{{vm}}/guest/processes/{{pid}} action=get method post input argument name type required description path parameters vm string required virtual machine to perform the operation on the parameter must be an identifier for the resource type path parameters pid string required specifies the process to query credentials object optional parameter for get vm pid processes credentials interactive session boolean required if set, the operation will interact with the logged in desktop session in the guest credentials type string required types of guest credentials credentials user name string optional guest user to be associated with the credentials credentials password string optional this field is optional and it is only relevant when the value of credentials credentials saml token string optional this field is optional and it is only relevant when the value of credentials input example {"json body" {"credentials" {"interactive session"\ false,"type" "string","user name" "string","password" "string","saml token" "string"}},"path parameters" {"vm" "vm name","pid" "query"}} output parameter type description status code number http status code of the response reason string response reason phrase name string name of the resource owner string output field owner command string output field command started string output field started finished string output field finished exit code number output field exit code output example {"status code" 200,"response headers" {},"reason" "ok","json body" {"name" "string","owner" "string","command" "string","started" "string","finished" "string","exit code" 0}} list guest process lists all processes running in a specified vm's guest os, including those initiated by processes, requiring vm identifier and credentials endpoint url /api/vcenter/vm/{{vm}}/guest/processes action=list method post input argument name type required description path parameters vm string required virtual machine id the parameter must be an identifier for the resource type credentials object optional the guest authentication data credentials interactive session boolean required the operation will interact with the logged in desktop session in the guest credentials type string required types of guest credentials credentials user name string optional the guest user to be associated with the credentials credentials password string optional only relevant when the value of credentials credentials saml token string optional saml bearer token this field is optional and it is only relevant when the value of credentials input example {"json body" {"credentials" {"interactive session"\ false,"type" "string","user name" "string","password" "string","saml token" "string"}},"path parameters" {"vm" "vmware name"}} output parameter type description status code number http status code of the response reason string response reason phrase output example {"status code" 200,"response headers" {},"reason" "ok","json body" \[{"name" "string","pid" 0,"owner" "string","command" "string","started" "string"}]} reboot guest power issues a reboot request to the guest operating system in vmware vcenter, targeting the virtual machine specified by the 'vm' path parameter endpoint url /api/vcenter/vm/{{vm}}/guest/power action=reboot method post input argument name type required description path parameters vm string required identifier of the virtual machine the parameter must be an identifier for the resource type input example {"path parameters" {"vm" "vmware name"}} output parameter type description status code number http status code of the response reason string response reason phrase output example {"status code" 204,"response headers" {},"reason" "ok","json body" {}} shutdown guest power issues a clean shutdown request to the guest operating system in vmware vcenter, targeting the specified virtual machine endpoint url /api/vcenter/vm/{{vm}}/guest/power action=shutdown method post input argument name type required description path parameters vm string required identifier of the virtual machine the parameter must be an identifier for the resource type input example {"path parameters" {"vm" "vmware name"}} output parameter type description status code number http status code of the response reason string response reason phrase output example {"status code" 204,"response headers" {},"reason" "ok","json body" {}} standby guest power issues a suspend operation request to the guest os in vmware vcenter, requiring the virtual machine identifier endpoint url /api/vcenter/vm/{{vm}}/guest/power action=standby method post input argument name type required description path parameters vm string required identifier of the virtual machine the parameter must be an identifier for the resource type input example {"path parameters" {"vm" "vmware name"}} output parameter type description status code number http status code of the response reason string response reason phrase output example {"status code" 204,"response headers" {},"reason" "ok","json body" {}} vm get guest local filesystem retrieve details of the local file systems within a specified guest operating system in vmware vcenter endpoint url /api/vcenter/vm/{{vm}}/guest/local filesystem method get input argument name type required description path parameters vm string required identifier of the virtual machine the parameter must be an identifier for the resource type input example {"path parameters" {"vm" "vmware name"}} output parameter type description status code number http status code of the response reason string response reason phrase output example {"status code" 200,"response headers" {},"reason" "ok","json body" {}} vm get guest networking retrieves network configuration details from the guest operating system for a specified vm in vmware vcenter endpoint url /api/vcenter/vm/{{vm}}/guest/networking method get input argument name type required description path parameters vm string required identifier of the virtual machine the parameter must be an identifier for the resource type input example {"path parameters" {"vm" "vmware name"}} output parameter type description status code number http status code of the response reason string response reason phrase dns values object value for the parameter dns values host name string name of the resource dns values domain name string name of the resource dns object output field dns dns ip addresses array output field dns ip addresses dns search domains array output field dns search domains output example {"status code" 200,"response headers" {},"reason" "ok","json body" {"dns values" {"host name" "string","domain name" "string"},"dns" {"ip addresses" \[],"search domains" \[]}}} vm get guest operations retrieve the current status of guest operations for a specified virtual machine in vmware vcenter endpoint url /api/vcenter/vm/{{vm}}/guest/operations method get input argument name type required description path parameters vm string required identifier of the virtual machine the parameter must be an identifier for the resource type input example {"path parameters" {"vm" "vmware name"}} output parameter type description status code number http status code of the response reason string response reason phrase guest operations ready boolean output field guest operations ready interactive guest operations ready boolean output field interactive guest operations ready output example {"status code" 200,"response headers" {},"reason" "ok","json body" {"guest operations ready"\ false,"interactive guest operations ready"\ false}} response headers header description example content type the media type of the resource application/json date the date and time at which the message was originated thu, 01 jan 2024 00 00 00 gmt