Cosmic User API Reference

listIpForwardingRules

List the IP forwarding rules

Request parameters

Parameter Name	Description	Required
account	list resources by account. Must be used with the domainId parameter.	false
domainid	list only resources belonging to the domain specified	false
id	Lists rule with the specified ID.	false
ipaddressid	list the rule belonging to this public IP address	false
isrecursive	defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.	false
keyword	List by keyword	false
listall	If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false	false
page		false
pagesize		false
projectid	list objects by project	false
virtualmachineid	Lists all rules applied to the specified VM.	false

Response Name	Description
id	the ID of the port forwarding rule
cidrlist	the cidr list to forward traffic from
fordisplay	is firewall for display to the regular user
ipaddress	the public ip address for the port forwarding rule
ipaddressid	the public ip address id for the port forwarding rule
networkid	the id of the guest network the port forwarding rule belongs to
privateendport	the ending port of port forwarding rule's private port range
privateport	the starting port of port forwarding rule's private port range
protocol	the protocol of the port forwarding rule
publicendport	the ending port of port forwarding rule's private port range
publicport	the starting port of port forwarding rule's public port range
state	the state of the rule
virtualmachinedisplayname	the VM display name for the port forwarding rule
virtualmachineid	the VM ID for the port forwarding rule
virtualmachinename	the VM name for the port forwarding rule
vmguestip	the vm ip address for the port forwarding rule
*tags()**	the list of resource tags associated with the rule
account	the account associated with the tag
customer	customer associated with the tag
domain	the domain associated with the tag
domainid	the ID of the domain associated with the tag
key	tag key name
project	the project name where tag belongs to
projectid	the project id the tag belongs to
resourceid	id of the resource
resourcetype	resource type
value	tag value