Software License

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

Updates a software license.

SYNTAX

Set-NinjaOneSoftwareLicense [-LicenseId] <Int32> [-License] <Object> [-ProgressAction <ActionPreference>]
 [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

Updates an existing software license via the NinjaOne v2 API.

EXAMPLES

EXAMPLE 1

Set-NinjaOneSoftwareLicense -LicenseId 1 -License @{ name = 'Microsoft Office 365' }

Updates the software license with ID 1.

EXAMPLE 2

# FULL REQUEST EXAMPLE (AUTO-GENERATED) - BEGIN
 PS> $body = @{
	name = "string"
	description = "string"
	type = "PER_DEVICE"
	purchaseDate = 0
	publisherId = 0
	vendorId = 0
	scope = @{
		global = $false
		organizationIds = @(
			0
		)
		locationIds = @(
			0
		)
	}
	quantity = 0
	currentUsage = 0
	term = @{
		renewalUnit = "MONTH"
		value = 0
		expirationDate = 0
		autoRenewal = $false
		generateActivityAlert = $false
		daysBeforeExpiration = 0
		hasNotifiedExpirationDate = $false
		hasNotifiedUpToRenewal = $false
	}
	notificationChannelInfo = @{
		email = "string"
		sms = "string"
		pushNotification = "string"
	}
	assigmentAutomationSettings = @{
		assignmentType = "NORMALIZED_SOFTWARE"
		type = "string"
	}
	assignedLicenses = @(
		0
	)
	unassignedLicenses = @(
		0
	)
	note = "string"
}
PS> Set-NinjaOneSoftwareLicense -LicenseId 1 -License $body
# FULL REQUEST EXAMPLE (AUTO-GENERATED) - END

Full request example (auto-generated).

PARAMETERS

-LicenseId

The ID of the software license to update

Type: Int32
Parameter Sets: (All)
Aliases: id

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

-License

Software license update payload per API schema

Type: Object
Parameter Sets: (All)
Aliases: body

Required: True
Position: 2
Default value: None
Accept pipeline input: True (ByPropertyName)
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 updated software license.

NOTES

RELATED LINKS

https://docs.homotechsual.dev/modules/ninjaone/commandlets/Set/softwarelicense