Skip to main content

1E SDK

Patch.TestConnection

Method

TestConnection

Module

Patch

Library

Core

Action

Check that the source for patches is accessible.

Parameters

Note

If this parameter is not specified, the Tachyon Agent attempts to deduce the source as follows:

  1. If a CAB-file is specified and exists (although is not necessarily valid), the source is implicitly ' CAB '.

  2. Else if the SCCM client is enabled for software updates, the source is implicitly ' SCCM '.

  3. Else if a local Windows Software Update server is configured, the source is implicitly ' WSUSL '.

  4. Else if the remote Windows Software Update Service is configured, the source is implicitly ' WSUSR '.

  5. Else the source is unknown and must be specified explicitly; this causes an error.

Note

When testing a WSUSL connection, this method includes a built-in random stagger interval so that multiple Tachyon Agents do not overwhelm the local WSUS server simultaneously.

CabFilePath (string; default empty): The full path of the location of the .cab file if Source is 'CAB'.

Note

This must be specified if Source is 'CAB' and should not be specified for any other Source value.

If the path is specified it must be to a local CAB-file. Shared, i.e. remote, CAB-files are not supported by Windows Update Agent.

Warning

Only the existence of the CAB-file is checked; the contents are NOT validated.

Return values

ConnectionOk (boolean): Whether the Source can be accessed or not.

Source (string): Where the updates come from. One of:

Note

This is useful if the source is not specified as an input parameter and has to be deduced.

SourceId (string): The identity of the source of updates. E.g. for a 'SCCM' source the site ID, or for WSUS the URL.

Example

@ConfigMgrOk = Patch.TestConnection(Source: "SCCM")

Platforms

  • Windows

Notes

In this section: