Skip to main content

Overview

This document sets the 'xPVAL Org Name' custom field value on machines based on the Machine's Parent Organization Name. This information is essential for other functions in the VSA, as it is not otherwise available.

Requirements

  • Module: VSAAPI

Process

The script utilizes API calls in the VSAAPI module to retrieve the Organization name from the Agent API and sets the appropriate custom field.

Payload Usage

The parameters are passed to VSAAPI for use in the API call:

./Update-VsaOrgNameCustomField.ps1 -BaseURL https://vsa.provaltech.com -VsaUserName apiservice -RestApiToken abcd-1234-efgh-5678

Parameters

ParameterAliasRequiredDefaultTypeDescription
BaseURLTrueStringVSA URL
VsaUserNameTrueStringUser with API Access
RestApiTokenTrueStringREST API Token for User

Output

The location of output for log, result, and error files is as follows:

./Update-VsaOrgNameCustomField-log.txt