Remove-NIOSObject¶
SYNOPSIS¶
Generic Wrapper function for removing objects from the NIOS WAPI
SYNTAX¶
Remove-NIOSObject [-ObjectRef] <String> [[-Server] <String>] [[-GridUID] <String>] [[-GridName] <String>]
[[-ApiVersion] <String>] [-SkipCertificateCheck] [[-Creds] <PSCredential>] [-Force] [-WhatIf] [-Confirm]
[<CommonParameters>]
DESCRIPTION¶
Generic Wrapper function for removing objects from the NIOS WAPI, either directly or via Universal DDI Federation
EXAMPLES¶
EXAMPLE 1¶
@{
name = 'my.example.com'
ipv4addr = '172.25.22.12'
comment = 'My A Record'
} | New-NIOSObject -ObjectType 'record:a'
record:a/ZG5zLmJpbmRfYSQuX2RlZmF1bHQuY29tLmV4YW1wbGUsbXksMTcyLjI1LjIyLjEy:my.example.com/default
PARAMETERS¶
-ObjectRef¶
Specify the object _ref to remove.
Type: String
Parameter Sets: (All)
Aliases: ref, _ref
Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-Server¶
Specify the NIOS Grid Manager IP or FQDN to use
This parameter can be ommitted if the Server is stored by using Set-NIOSConnectionProfile
This is used only when connecting to NIOS directly.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-GridUID¶
Specify the NIOS Grid UID (license_uid). This indicates which Grid to connect to when using NIOS Federation within Universal DDI.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-GridName¶
Specify the NIOS Grid Name in Universal DDI instead of the GridUID. This is convient, but requires resolving the license_uid on every API Call.
This parameter can be ommitted if the Federated Grid has been stored by using Set-NIOSConnectionProfile
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ApiVersion¶
The version of the NIOS API to use (WAPI)
This parameter can be ommitted if the API Version is stored by using Set-NIOSConnectionProfile
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 5
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-SkipCertificateCheck¶
If this parameter is set, SSL Certificates Checks will be ignored.
This parameter can be ommitted if the configuration has been stored by using Set-NIOSConnectionProfile
This is used only when connecting to NIOS directly.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-Creds¶
The creds parameter can be used to specify credentials as part of the command.
This parameter can be ommitted if the Credentials are stored by using Set-NIOSConnectionProfile
This is used only when connecting to NIOS directly.
Type: PSCredential
Parameter Sets: (All)
Aliases:
Required: False
Position: 6
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Force¶
Perform the operation without prompting for confirmation. By default, this function will always prompt for confirmation unless -Confirm:$false or -Force is specified, or $ConfirmPreference is set to None.
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.