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 = @{
    unassignedLicenses = @(
        0
    )
    note = "string"
    purchaseDate = 0
    assignedLicenses = @(
        0
    )
    notificationChannelInfo = @{
        pushNotification = "string"
        sms = "string"
        email = "string"
    }
    publisherId = 0
    type = "PER_DEVICE"
    assigmentAutomationSettings = @{
        type = "string"
        assignmentType = "NORMALIZED_SOFTWARE"
    }
    quantity = 0
    description = "string"
    scope = @{
        locationIds = @(
            0
        )
        global = $false
        organizationIds = @(
            0
        )
    }
    vendorId = 0
    currentUsage = 0
    term = @{
        expirationDate = 0
        value = 0
        generateActivityAlert = $false
        hasNotifiedExpirationDate = $false
        renewalUnit = "MONTH"
        hasNotifiedUpToRenewal = $false
        daysBeforeExpiration = 0
        autoRenewal = $false
    }
    name = "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