Skip to content

Set-PveClusterFirewallAliases

Update IP or Network alias.

API: PUT /cluster/firewall/aliases/{name}, Proxmox VE API viewer

Set-PveClusterFirewallAliases
[-PveTicket <PveTicket>]
-Cidr <string>
[-Comment <string>]
[-Digest <string>]
-Name <string>
[-Rename <string>]
[<CommonParameters>]
Parameter Type Required Description
-PveTicket PveTicket No Ticket data connection.
-Cidr string Yes Network/IP specification in CIDR format.
-Comment string No
-Digest string No Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.
-Name string Yes Alias name.
-Rename string No Rename an existing alias.

Every parameter also binds by property name from the pipeline, so an object with node and vmid properties (the output of Get-PveGuest, for one) fills -Node and -Vmid. Without -PveTicket the cmdlet uses the last connection, see Connection.

A PveResponse: the data returned by Proxmox VE is in .Response.data, the outcome in .IsSuccessStatusCode. See Results and Errors.