CreateUpdateDevices

Modified on Fri, 17 Nov 2023 at 01:53 PM

Can be use to create a new device or update an existing one in EPM and assign Custom Inventory (= custom data fields). This can be useful for connecting asset management or CMDB systems (e.g. Jira). Supports customizable identification for existing devices.

Included since version:	4.4.20
API Endpoint:	http://coreservername/five9sWS/five9sWS.asmx
Parameter:	JSON-Structure

For ease of use, you need to import the Console-API-Module.

All documentation can also be seen in the API Module.

Included in version 4.4.20

Parameter:	Description:
uri	string, optional web Service URL e.g.: http://coreservername/five9sWS/five9sWS.asmx
pat	string, mandatory the Personal Access Token
computerData	PSCustomObject arrray, mandatory a list of target devices with Hostname, SerialNumber, MAC, and Custom Inventory
apiConfiguration	PSCustomObject, mandatory allows to change the validation to identify new / existing devices. Here you can set the property that will be the primary identifier

Get started with the following PowerShell:

Import-Module $PSScriptRoot\Console-API-Module.psm1 -Verbose #you need to execute this line once, so that powershell can offer intelliSense support

# Arrange the parameters
$wsdlUrl = "http://coreserver/five9sWS.asmx?wsdl" # web service URL, you need to replace the 'coreserver' with your actual value
$pat = "879067F0F16_YourPatHere_024214A4"
[PSCustomObject[]] $computerData = @(
    [PSCustomObject]@{
        Hostname      = ""
        SerialNumber  = "SNA009"
        MAC           = ""
        CI            = @(
            [PSCustomObject]@{
                Name  = "CI ID"
                Value = "302458"
            }
        )
    }
)
$apiConfiguration = [PSCustomObject]@{
    ExistingDeviceValidations = @("SerialNumber")
    NewDeviceValidations      = @("SerialNumber")
}

# Action
Invoke-CreateUpdateDevices  -uri $wsdlUrl -pat $pat -computerData $computerData2 -apiConfiguration $apiConfiguration

The result from the request will look like this:

Thank you for using this service

How to update Advanced Patch settings?

To update Advanced Patch Values, please use the CI Collection with the following static names:

CI = @(
	[PSCustomObject]@{
		Name  = "PatchGroup"
		Value = "Sharepoint Server"
	},
	[PSCustomObject]@{
		Name  = "PatchStep"
		Value = "IT Test"
	},
	[PSCustomObject]@{
		Name  = "User to notify"
		Value = "user@company.com"
	}
)

It is important to ensure the values are correct and exist.