lib/fog/profitbricks/requests/compute/create_firewall_rule.rb
module Fog
module Compute
class ProfitBricks
class Real
# Adds a Firewall Rule to the NIC
#
# ==== Parameters
# * datacenter_id<~String> - Required, UUID of the virtual data center
# * server_id<~String> - Required, UUID of the server
# * nic_id<~String> - Required, UUID of the NIC
# * options<~Hash>:
# * name<~String> - The name of the Firewall Rule
# * protocol<~String> - The protocol for the rule: TCP, UDP, ICMP, ANY
# * sourceMac<~String> - Only traffic originating from the respective MAC address is allowed.
# Valid format: aa:bb:cc:dd:ee:ff. Value null allows all source MAC address
# * sourceIp<~String> - Only traffic originating from the respective IPv4 address is allowed. Value null allows all source IPs
# * targetIp<~String> - In case the target NIC has multiple IP addresses, only traffic directed to the respective
# IP address of the NIC is allowed. Value null allows all target IPs
# * portRangeStart<~String> - Defines the start range of the allowed port (from 1 to 65534) if protocol TCP or UDP is chosen.
# Leave portRangeStart and portRangeEnd value null to allow all ports
# * portRangeEnd<~String> - Defines the end range of the allowed port (from 1 to 65534) if the protocol TCP or UDP is chosen.
# Leave portRangeStart and portRangeEnd null to allow all ports
# * icmpType<~String> - Defines the allowed type (from 0 to 254) if the protocol ICMP is chosen. Value null allows all types
# * icmpCode<~String> - Defines the allowed code (from 0 to 254) if protocol ICMP is chosen. Value null allows all codes
#
# ==== Returns
# * response<~Excon::Response>:
# * body<~Hash>:
# * id<~String> - The resource's unique identifier
# * type<~String> - The type of the created resource
# * href<~String> - URL to the object’s representation (absolute path)
# * metadata<~Hash> - Hash containing the Firewall Rule metadata
# * createdDate<~String> - The date the resource was created
# * createdBy<~String> - The user who created the resource
# * etag<~String> - The etag for the resource
# * lastModifiedDate<~String> - The last time the resource has been modified
# * lastModifiedBy<~String> - The user who last modified the resource
# * state<~String> - Firewall Rule state
# * properties<~Hash> - Hash containing the Firewall Rule properties
# * name<~String> - The name of the Firewall Rule
# * protocol<~String> - The protocol for the rule: TCP, UDP, ICMP, ANY
# * sourceMac<~String> - Only traffic originating from the respective MAC address is allowed.
# Valid format: aa:bb:cc:dd:ee:ff. Value null allows all source MAC address
# * sourceIp<~String> - Only traffic originating from the respective IPv4 address is allowed. Value null allows all source IPs
# * targetIp<~String> - In case the target NIC has multiple IP addresses, only traffic directed
# to the respective IP address of the NIC is allowed. Value null allows all target IPs
# * icmpCode<~String> - Defines the allowed code (from 0 to 254) if protocol ICMP is chosen. Value null allows all codes
# * icmpType<~String> - Defines the allowed type (from 0 to 254) if the protocol ICMP is chosen. Value null allows all types
# * portRangeStart<~String> - Defines the start range of the allowed port (from 1 to 65534) if protocol TCP or UDP is chosen.
# Leave portRangeStart and portRangeEnd value null to allow all ports
# * portRangeEnd<~String> - Defines the end range of the allowed port (from 1 to 65534) if the protocol TCP or UDP is chosen.
# Leave portRangeStart and portRangeEnd null to allow all ports
#
# {ProfitBricks API Documentation}[https://devops.profitbricks.com/api/cloud/v2/#create-firewall-rule]
def create_firewall_rule(datacenter_id, server_id, nic_id, options = {})
firewall_rule = {
:properties => options
}
request(
:expects => [202],
:method => 'POST',
:path => "/datacenters/#{datacenter_id}/servers/#{server_id}/nics/#{nic_id}/firewallrules",
:body => Fog::JSON.encode(firewall_rule)
)
end
end
class Mock
def create_firewall_rule(datacenter_id, server_id, nic_id, options = {})
response = Excon::Response.new
response.status = 202
properties = {}
properties['name'] = options[:name]
properties['protocol'] = options[:protocol]
properties['source_mac'] = options[:sourceMac]
properties['port_range_start'] = options[:portRangeStart]
properties['port_range_end'] = options[:portRangeEnd]
firewall_rule_id = Fog::UUID.uuid
firewall_rule = {
'id' => firewall_rule_id,
'type' => 'firewall-rule',
'href' => "https://api.profitbricks.com/rest/v2/datacenters/#{datacenter_id}/servers/#{server_id}/nics/#{nic_id}/firewallrules/#{firewall_rule_id}",
'metadata' => {
'createdDate' => '2015-03-18T19:00:51Z',
'createdBy' => 'test@stackpointcloud.com',
'etag' => 'faa67fbacb1c0e2e02cf9650657251f2',
'lastModifiedDate' => '2015-03-18T19:00:51Z',
'lastModifiedBy' => 'test@stackpointcloud.com',
'state' => 'AVAILABLE'
},
'properties' => properties,
'datacenter_id' => datacenter_id,
'server_id' => server_id,
'nic_id' => nic_id
}
data[:firewall_rules]['items'] << firewall_rule
response.body = firewall_rule
response
end
end
end
end
end