Remove-VBRCloudPublicIP

In this article

    Short Description

    Removes IP addresses from public IP addresses pools.

    Applies to

    Platform: VMware, Hyper-V

    Product Edition: Standard, Enterprise, Enterprise Plus, Veeam Universal License

    Requires a VCP license.

    Syntax

    Remove-VBRCloudPublicIP -CloudIp <VBRCloudIP[]> [-WhatIf] [-Confirm] [<CommonParameters>]

    Detailed Description

    This cmdlet removes a selected IP address from the public IP addresses pool.

    Parameters

    Parameter

    Description

    Required

    Position

    Accept
    Pipeline
    Input

    Accept
    Wildcard
    Characters

    CloudIp

    Specifies the array of IP addresses that you want to remove.

    Accepts VBRCloudIP type.

    True

    Named

    True (ByValue,
    ByProperty
    Name)

    False

    WhatIf

    Specifies whether the cmdlet writes a message that describes the effects of running the cmdlet without actually performing any action.

    False

    Named

    False

    False

    Confirm

    Specifies whether the cmdlet displays a prompt that asks if the user is sure that they want to continue.

    False

    Named

    False

    False

    <CommonParameters>

    This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About CommonParameters section of Microsoft Docs.

    Return Type

    None

    Example 1

    This example shows how to remove the first IP address from the configured pool of public IP addresses.

    1. Run Get-VBRCloudPublicIP to get the pool of IP addresses. Save the pool to the $ip variable.
    2. Run Remove-VBRCloudPublicIP to remove the first IP address. Use the $ip variable.

    $ip = Get-VBRCloudPublicIP

    Remove-VBRCloudPublicIP –CloudIP $ip[0]

    Example 2

    This example shows how to remove all IP addresses assigned to the cloud tenant named “ABC Company”.

    1. Run  Get-VBRCloudTenant to get the tenant. Save the result to the $tenant variable.
    2. Run Get-VBRCloudPublicIP to get the pool of IP addresses allocated to the tenant. Use the $tenant variable. Save the result to the $ip variable.
    3. Run Remove-VBRCloudPublicIP to remove the IP addresses. Use the $ip variable.

    $tenant = Get-VBRCloudTenant –Name "ABC Company"

    $ip = Get-VBRCloudPublicIP –Tenant $tenant

    Remove-VBRCloudPublicIP –CloudIP $ip

    Related Commands

    Get-VBRCloudPublicIP