Set-ITGlueConfigurationInterface
SYNOPSIS
Update one or more configuration interfaces
SYNTAX
Bulk_Update (Default)
Set-ITGlueConfigurationInterface [-FilterID <Int64>] [-FilterIPAddress <String>] -Data <Object> [-WhatIf]
[-Confirm] [<CommonParameters>]
Update
Set-ITGlueConfigurationInterface [-ConfigurationID <Int64>] -ID <Int64> -Data <Object> [-WhatIf] [-Confirm]
[<CommonParameters>]
DESCRIPTION
The Set-ITGlueConfigurationInterface cmdlet updates one or more configuration interfaces
Any attributes you don’t specify will remain unchanged
This function can call the following endpoints: Update = /configuration_interfaces/:id /configurations/:conf_id/relationships/configuration_interfaces/:id
Bulk_Update = /configuration_interfaces
/configurations/:conf_id/relationships/configuration_interfaces/:id
Examples of JSON objects can be found under ITGlues developer documentation https://api.itglue.com/developer
EXAMPLES
EXAMPLE 1
Set-ITGlueConfigurationInterface -ID 8765309 -Data $JsonObject
Updates an interface for the defined configuration with the structured JSON object
EXAMPLE 2
Set-ITGlueConfigurationInterface -FilterID 8765309 -Data $JsonObject
Bulk updates interfaces associated to the defined configuration filter with the specified JSON object
PARAMETERS
-ConfigurationID
A valid configuration ID in your account
Type: Int64
Parameter Sets: Update
Aliases: conf_id, configuration_id
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-ID
A valid configuration interface ID in your account
Example: 12345
Type: Int64
Parameter Sets: Update
Aliases:
Required: True
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-FilterID
Configuration id to filter by
Type: Int64
Parameter Sets: Bulk_Update
Aliases: filter_id
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-FilterIPAddress
Filter by an IP4 or IP6 address
Type: String
Parameter Sets: Bulk_Update
Aliases: filter_ip_address
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Data
JSON object or array depending on bulk changes or not
Type: Object
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
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
NOTES
N/A
RELATED LINKS
https://api.itglue.com/developer/#configuration-interfaces-update