Options
All
  • Public
  • Public/Protected
  • All
Menu

Class PatchingAPI

Patching module

Hierarchy

  • default
    • PatchingAPI

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

config

config: AutomateConfig

paginate

paginate: (apiMethod: Function, paginateArgs: PaginationOptions, ...methodArgs: Record<string, unknown>[]) => Promise<unknown[]>

Type declaration

    • (apiMethod: Function, paginateArgs: PaginationOptions, ...methodArgs: Record<string, unknown>[]): Promise<unknown[]>
    • example
       cwa.paginate(cwa.ComputersAPI.getComputerList, {startPage: 1, pageSize: 1000}, {conditions: 'inactiveFlag = false'})

      Parameters

      • apiMethod: Function
      • paginateArgs: PaginationOptions
      • Rest ...methodArgs: Record<string, unknown>[]

      Returns Promise<unknown[]>

request

request: (args: RequestOptions) => Promise<any>

Type declaration

Accessors

token

  • get token(): undefined | string
  • set token(token: undefined | string): void

  • Returns undefined | string

  • Parameters

    • token: undefined | string

    Returns void

Methods

deployAllApproved

  • deployAllApproved(PatchActionArgs: { content: { application/json: { EntityId?: number; EntityType?: number }; application/x-www-form-urlencoded: { EntityId?: number; EntityType?: number }; application/xml: { EntityId?: number; EntityType?: number }; text/json: { EntityId?: number; EntityType?: number }; text/xml: { EntityId?: number; EntityType?: number } } }): Promise<undefined>

  • Parameters

    • PatchActionArgs: { content: { application/json: { EntityId?: number; EntityType?: number }; application/x-www-form-urlencoded: { EntityId?: number; EntityType?: number }; application/xml: { EntityId?: number; EntityType?: number }; text/json: { EntityId?: number; EntityType?: number }; text/xml: { EntityId?: number; EntityType?: number } } }
      • content: { application/json: { EntityId?: number; EntityType?: number }; application/x-www-form-urlencoded: { EntityId?: number; EntityType?: number }; application/xml: { EntityId?: number; EntityType?: number }; text/json: { EntityId?: number; EntityType?: number }; text/xml: { EntityId?: number; EntityType?: number } }
        • application/json: { EntityId?: number; EntityType?: number }
          • Optional EntityId?: number

            Format: int32

          • Optional EntityType?: number

            Format: int32

        • application/x-www-form-urlencoded: { EntityId?: number; EntityType?: number }
          • Optional EntityId?: number

            Format: int32

          • Optional EntityType?: number

            Format: int32

        • application/xml: { EntityId?: number; EntityType?: number }
          • Optional EntityId?: number

            Format: int32

          • Optional EntityType?: number

            Format: int32

        • text/json: { EntityId?: number; EntityType?: number }
          • Optional EntityId?: number

            Format: int32

          • Optional EntityType?: number

            Format: int32

        • text/xml: { EntityId?: number; EntityType?: number }
          • Optional EntityId?: number

            Format: int32

          • Optional EntityType?: number

            Format: int32

    Returns Promise<undefined>

deployAllSecurity

  • deployAllSecurity(PatchActionArgs: { content: { application/json: { EntityId?: number; EntityType?: number }; application/x-www-form-urlencoded: { EntityId?: number; EntityType?: number }; application/xml: { EntityId?: number; EntityType?: number }; text/json: { EntityId?: number; EntityType?: number }; text/xml: { EntityId?: number; EntityType?: number } } }): Promise<undefined>

  • Parameters

    • PatchActionArgs: { content: { application/json: { EntityId?: number; EntityType?: number }; application/x-www-form-urlencoded: { EntityId?: number; EntityType?: number }; application/xml: { EntityId?: number; EntityType?: number }; text/json: { EntityId?: number; EntityType?: number }; text/xml: { EntityId?: number; EntityType?: number } } }
      • content: { application/json: { EntityId?: number; EntityType?: number }; application/x-www-form-urlencoded: { EntityId?: number; EntityType?: number }; application/xml: { EntityId?: number; EntityType?: number }; text/json: { EntityId?: number; EntityType?: number }; text/xml: { EntityId?: number; EntityType?: number } }
        • application/json: { EntityId?: number; EntityType?: number }
          • Optional EntityId?: number

            Format: int32

          • Optional EntityType?: number

            Format: int32

        • application/x-www-form-urlencoded: { EntityId?: number; EntityType?: number }
          • Optional EntityId?: number

            Format: int32

          • Optional EntityType?: number

            Format: int32

        • application/xml: { EntityId?: number; EntityType?: number }
          • Optional EntityId?: number

            Format: int32

          • Optional EntityType?: number

            Format: int32

        • text/json: { EntityId?: number; EntityType?: number }
          • Optional EntityId?: number

            Format: int32

          • Optional EntityType?: number

            Format: int32

        • text/xml: { EntityId?: number; EntityType?: number }
          • Optional EntityId?: number

            Format: int32

          • Optional EntityType?: number

            Format: int32

    Returns Promise<undefined>

getApprovalPolicyListAsync

getGroupPatchingPolicyListAsync

  • getGroupPatchingPolicyListAsync(params?: types.AutomateApis.CommonParameters): Promise<{ ApprovalPolicies?: { AutomaticApprovalSettings?: { Categories?: { CategoryId?: number; CategoryName?: string }[]; CvssLowerBound?: number; Severities?: string[]; Titles?: string[] }; AutomaticDenySettings?: { Categories?: { CategoryId?: number; CategoryName?: string }[]; Severities?: string[]; Titles?: string[] }; AutomaticIgnoreSettings?: { Categories?: { CategoryId?: number; CategoryName?: string }[]; Severities?: string[]; Titles?: string[] }; HasStaging?: boolean; Id?: number; IsDefaultPolicy?: boolean; Name?: string; PilotDuration?: number; TestDuration?: number }[]; AutoJoinSettings?: { ComputerAutoJoinSearch?: { Name?: string; SearchId?: number }; IsLimitedToComputerAutoJoin?: boolean }; GroupId?: number; GroupName?: string; IsManual?: boolean; IsPatchingGroup?: boolean; MicrosoftUpdatePolicy?: { CreateRestorePoint?: boolean; DaytimePatching?: boolean; DaytimePatchingMinimumUptime?: number; Id?: number; InstallMissingBaselinePatches?: boolean; Name?: string; PatchingPolicySchedule?: { DatesScheduleSettings?: { Dates?: number[]; LastDayOfMonth?: boolean; MonthlyOccurence?: string[] }; DaysScheduleSettings?: { DailyOccurence?: string[]; MonthlyOccurence?: string[]; WeeklyOccurence?: string[] }; Duration?: string; PolicyScheduleType?: { Id?: number; Name?: string }; StartTime?: number }; PatchingPolicyScriptOptions?: { AfterScript?: { ScriptGuid?: string; ScriptName?: string }; BeforeScript?: { ScriptGuid?: string; ScriptName?: string }; CancelActionOnBeforeScriptFailure?: boolean }; ScheduleDay?: { Id?: number; Name?: string }; ScheduleStartHour?: string; ScheduleTimeSpan?: string; UpdateMode?: { Id?: number; Name?: string }; WakeSystem?: boolean; Windows10UpdatePolicySettings?: { FeatureUpdateDeferment?: number; QualityUpdateDeferment?: number; ServiceBranch?: string } }; Priority?: number; RebootPolicy?: { Id?: number; MinutesAfterInstallToReboot?: number; Name?: string; RebootAction?: { Id?: number; Name?: string }; RebootMode?: { Id?: number; Name?: string }; RebootPriorToFirstPatchInstall?: boolean; SetMaintenanceWindowForReboot?: boolean }; ThirdPartyUpdatePolicy?: { CreateRestorePoint?: boolean; DaytimePatching?: boolean; Id?: number; Name?: string; ScheduleDay?: { Id?: number; Name?: string }; ScheduleStartHour?: string; ScheduleTimeSpan?: string; WakeSystem?: boolean }; WindowsComputerCount?: number }[]>

  • Parameters

    Returns Promise<{ ApprovalPolicies?: { AutomaticApprovalSettings?: { Categories?: { CategoryId?: number; CategoryName?: string }[]; CvssLowerBound?: number; Severities?: string[]; Titles?: string[] }; AutomaticDenySettings?: { Categories?: { CategoryId?: number; CategoryName?: string }[]; Severities?: string[]; Titles?: string[] }; AutomaticIgnoreSettings?: { Categories?: { CategoryId?: number; CategoryName?: string }[]; Severities?: string[]; Titles?: string[] }; HasStaging?: boolean; Id?: number; IsDefaultPolicy?: boolean; Name?: string; PilotDuration?: number; TestDuration?: number }[]; AutoJoinSettings?: { ComputerAutoJoinSearch?: { Name?: string; SearchId?: number }; IsLimitedToComputerAutoJoin?: boolean }; GroupId?: number; GroupName?: string; IsManual?: boolean; IsPatchingGroup?: boolean; MicrosoftUpdatePolicy?: { CreateRestorePoint?: boolean; DaytimePatching?: boolean; DaytimePatchingMinimumUptime?: number; Id?: number; InstallMissingBaselinePatches?: boolean; Name?: string; PatchingPolicySchedule?: { DatesScheduleSettings?: { Dates?: number[]; LastDayOfMonth?: boolean; MonthlyOccurence?: string[] }; DaysScheduleSettings?: { DailyOccurence?: string[]; MonthlyOccurence?: string[]; WeeklyOccurence?: string[] }; Duration?: string; PolicyScheduleType?: { Id?: number; Name?: string }; StartTime?: number }; PatchingPolicyScriptOptions?: { AfterScript?: { ScriptGuid?: string; ScriptName?: string }; BeforeScript?: { ScriptGuid?: string; ScriptName?: string }; CancelActionOnBeforeScriptFailure?: boolean }; ScheduleDay?: { Id?: number; Name?: string }; ScheduleStartHour?: string; ScheduleTimeSpan?: string; UpdateMode?: { Id?: number; Name?: string }; WakeSystem?: boolean; Windows10UpdatePolicySettings?: { FeatureUpdateDeferment?: number; QualityUpdateDeferment?: number; ServiceBranch?: string } }; Priority?: number; RebootPolicy?: { Id?: number; MinutesAfterInstallToReboot?: number; Name?: string; RebootAction?: { Id?: number; Name?: string }; RebootMode?: { Id?: number; Name?: string }; RebootPriorToFirstPatchInstall?: boolean; SetMaintenanceWindowForReboot?: boolean }; ThirdPartyUpdatePolicy?: { CreateRestorePoint?: boolean; DaytimePatching?: boolean; Id?: number; Name?: string; ScheduleDay?: { Id?: number; Name?: string }; ScheduleStartHour?: string; ScheduleTimeSpan?: string; WakeSystem?: boolean }; WindowsComputerCount?: number }[]>

getMicrosoftUpdatePolicyListAsync

getPatchHistoryListAsync

getThirdPartyUpdatePolicyListAsync

reattemptFailed

  • reattemptFailed(PatchActionArgs: { content: { application/json: { EntityId?: number; EntityType?: number }; application/x-www-form-urlencoded: { EntityId?: number; EntityType?: number }; application/xml: { EntityId?: number; EntityType?: number }; text/json: { EntityId?: number; EntityType?: number }; text/xml: { EntityId?: number; EntityType?: number } } }): Promise<undefined>

  • Parameters

    • PatchActionArgs: { content: { application/json: { EntityId?: number; EntityType?: number }; application/x-www-form-urlencoded: { EntityId?: number; EntityType?: number }; application/xml: { EntityId?: number; EntityType?: number }; text/json: { EntityId?: number; EntityType?: number }; text/xml: { EntityId?: number; EntityType?: number } } }
      • content: { application/json: { EntityId?: number; EntityType?: number }; application/x-www-form-urlencoded: { EntityId?: number; EntityType?: number }; application/xml: { EntityId?: number; EntityType?: number }; text/json: { EntityId?: number; EntityType?: number }; text/xml: { EntityId?: number; EntityType?: number } }
        • application/json: { EntityId?: number; EntityType?: number }
          • Optional EntityId?: number

            Format: int32

          • Optional EntityType?: number

            Format: int32

        • application/x-www-form-urlencoded: { EntityId?: number; EntityType?: number }
          • Optional EntityId?: number

            Format: int32

          • Optional EntityType?: number

            Format: int32

        • application/xml: { EntityId?: number; EntityType?: number }
          • Optional EntityId?: number

            Format: int32

          • Optional EntityType?: number

            Format: int32

        • text/json: { EntityId?: number; EntityType?: number }
          • Optional EntityId?: number

            Format: int32

          • Optional EntityType?: number

            Format: int32

        • text/xml: { EntityId?: number; EntityType?: number }
          • Optional EntityId?: number

            Format: int32

          • Optional EntityType?: number

            Format: int32

    Returns Promise<undefined>

setToPilotStage

  • setToPilotStage(PatchActionArgs: { content: { application/json: { EntityId?: number; EntityType?: number }; application/x-www-form-urlencoded: { EntityId?: number; EntityType?: number }; application/xml: { EntityId?: number; EntityType?: number }; text/json: { EntityId?: number; EntityType?: number }; text/xml: { EntityId?: number; EntityType?: number } } }): Promise<undefined>

  • Parameters

    • PatchActionArgs: { content: { application/json: { EntityId?: number; EntityType?: number }; application/x-www-form-urlencoded: { EntityId?: number; EntityType?: number }; application/xml: { EntityId?: number; EntityType?: number }; text/json: { EntityId?: number; EntityType?: number }; text/xml: { EntityId?: number; EntityType?: number } } }
      • content: { application/json: { EntityId?: number; EntityType?: number }; application/x-www-form-urlencoded: { EntityId?: number; EntityType?: number }; application/xml: { EntityId?: number; EntityType?: number }; text/json: { EntityId?: number; EntityType?: number }; text/xml: { EntityId?: number; EntityType?: number } }
        • application/json: { EntityId?: number; EntityType?: number }
          • Optional EntityId?: number

            Format: int32

          • Optional EntityType?: number

            Format: int32

        • application/x-www-form-urlencoded: { EntityId?: number; EntityType?: number }
          • Optional EntityId?: number

            Format: int32

          • Optional EntityType?: number

            Format: int32

        • application/xml: { EntityId?: number; EntityType?: number }
          • Optional EntityId?: number

            Format: int32

          • Optional EntityType?: number

            Format: int32

        • text/json: { EntityId?: number; EntityType?: number }
          • Optional EntityId?: number

            Format: int32

          • Optional EntityType?: number

            Format: int32

        • text/xml: { EntityId?: number; EntityType?: number }
          • Optional EntityId?: number

            Format: int32

          • Optional EntityType?: number

            Format: int32

    Returns Promise<undefined>

setToProductionStage

  • setToProductionStage(PatchActionArgs: { content: { application/json: { EntityId?: number; EntityType?: number }; application/x-www-form-urlencoded: { EntityId?: number; EntityType?: number }; application/xml: { EntityId?: number; EntityType?: number }; text/json: { EntityId?: number; EntityType?: number }; text/xml: { EntityId?: number; EntityType?: number } } }): Promise<undefined>

  • Parameters

    • PatchActionArgs: { content: { application/json: { EntityId?: number; EntityType?: number }; application/x-www-form-urlencoded: { EntityId?: number; EntityType?: number }; application/xml: { EntityId?: number; EntityType?: number }; text/json: { EntityId?: number; EntityType?: number }; text/xml: { EntityId?: number; EntityType?: number } } }
      • content: { application/json: { EntityId?: number; EntityType?: number }; application/x-www-form-urlencoded: { EntityId?: number; EntityType?: number }; application/xml: { EntityId?: number; EntityType?: number }; text/json: { EntityId?: number; EntityType?: number }; text/xml: { EntityId?: number; EntityType?: number } }
        • application/json: { EntityId?: number; EntityType?: number }
          • Optional EntityId?: number

            Format: int32

          • Optional EntityType?: number

            Format: int32

        • application/x-www-form-urlencoded: { EntityId?: number; EntityType?: number }
          • Optional EntityId?: number

            Format: int32

          • Optional EntityType?: number

            Format: int32

        • application/xml: { EntityId?: number; EntityType?: number }
          • Optional EntityId?: number

            Format: int32

          • Optional EntityType?: number

            Format: int32

        • text/json: { EntityId?: number; EntityType?: number }
          • Optional EntityId?: number

            Format: int32

          • Optional EntityType?: number

            Format: int32

        • text/xml: { EntityId?: number; EntityType?: number }
          • Optional EntityId?: number

            Format: int32

          • Optional EntityType?: number

            Format: int32

    Returns Promise<undefined>

setToTestStage

  • setToTestStage(PatchActionArgs: { content: { application/json: { EntityId?: number; EntityType?: number }; application/x-www-form-urlencoded: { EntityId?: number; EntityType?: number }; application/xml: { EntityId?: number; EntityType?: number }; text/json: { EntityId?: number; EntityType?: number }; text/xml: { EntityId?: number; EntityType?: number } } }): Promise<undefined>

  • Parameters

    • PatchActionArgs: { content: { application/json: { EntityId?: number; EntityType?: number }; application/x-www-form-urlencoded: { EntityId?: number; EntityType?: number }; application/xml: { EntityId?: number; EntityType?: number }; text/json: { EntityId?: number; EntityType?: number }; text/xml: { EntityId?: number; EntityType?: number } } }
      • content: { application/json: { EntityId?: number; EntityType?: number }; application/x-www-form-urlencoded: { EntityId?: number; EntityType?: number }; application/xml: { EntityId?: number; EntityType?: number }; text/json: { EntityId?: number; EntityType?: number }; text/xml: { EntityId?: number; EntityType?: number } }
        • application/json: { EntityId?: number; EntityType?: number }
          • Optional EntityId?: number

            Format: int32

          • Optional EntityType?: number

            Format: int32

        • application/x-www-form-urlencoded: { EntityId?: number; EntityType?: number }
          • Optional EntityId?: number

            Format: int32

          • Optional EntityType?: number

            Format: int32

        • application/xml: { EntityId?: number; EntityType?: number }
          • Optional EntityId?: number

            Format: int32

          • Optional EntityType?: number

            Format: int32

        • text/json: { EntityId?: number; EntityType?: number }
          • Optional EntityId?: number

            Format: int32

          • Optional EntityType?: number

            Format: int32

        • text/xml: { EntityId?: number; EntityType?: number }
          • Optional EntityId?: number

            Format: int32

          • Optional EntityType?: number

            Format: int32

    Returns Promise<undefined>

verifyToken

  • verifyToken(): Promise<boolean>

Static getToken

  • getToken(__namedParameters: { password?: string; serverUrl: string; twoFactorPasscode?: string; username?: string }): Promise<{ AbsoluteExpirationDate?: string; AccessToken?: string; ExpirationDate?: string; IsInternalTwoFactorRequired?: boolean; IsTwoFactorRequired?: boolean; TokenType?: string; UserId?: string }>

  • Parameters

    • __namedParameters: { password?: string; serverUrl: string; twoFactorPasscode?: string; username?: string }
      • Optional password?: string
      • serverUrl: string
      • Optional twoFactorPasscode?: string
      • Optional username?: string

    Returns Promise<{ AbsoluteExpirationDate?: string; AccessToken?: string; ExpirationDate?: string; IsInternalTwoFactorRequired?: boolean; IsTwoFactorRequired?: boolean; TokenType?: string; UserId?: string }>

Generated using TypeDoc