Skip to main content

Integrity Check Job

Generated Cmdlet Help

This page has been generated from the NinjaOne PowerShell module source. To make changes please edit the appropriate PowerShell source file.

SYNOPSIS​

Creates a new backup integrity check job using the NinjaOne API.

SYNTAX​

Individual​

New-NinjaOneIntegrityCheckJob [-deviceId] <Int32> [-planUid] <Guid> [-show]
[-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]

Body​

New-NinjaOneIntegrityCheckJob [-integrityCheckJob] <Object> [-show] [-ProgressAction <ActionPreference>]
[-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION​

Create a new backup integrity check job using the NinjaOne v2 API.

EXAMPLES​

EXAMPLE 1​

# FULL REQUEST EXAMPLE (AUTO-GENERATED) - BEGIN
PS> $body = @{
planUid = "00000000-0000-0000-0000-000000000000"
deviceId = 0
}
PS> New-NinjaOneIntegrityCheckJob -integrityCheckJob $body
# FULL REQUEST EXAMPLE (AUTO-GENERATED) - END

Full request example (auto-generated).

PARAMETERS​

-deviceId​

The deviceId to create the integrity check job for.

Type: Int32
Parameter Sets: Individual
Aliases: id

Required: True
Position: 1
Default value: 0
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False

-planUid​

The planUid to create the integrity check job for.

Type: Guid
Parameter Sets: Individual
Aliases:

Required: True
Position: 2
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-integrityCheckJob​

The integrity check job body object (alternative to individual parameters).

Type: Object
Parameter Sets: Body
Aliases: body

Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-show​

Show the integrity check job that was created.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-WhatIf​

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Confirm​

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters​

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS​

OUTPUTS​

A powershell object containing the response.​

NOTES​

https://docs.homotechsual.dev/modules/ninjaone/commandlets/New/integritycheckjob