class VSphereAutomation::Appliance::NetworkingFirewallInboundApi

Attributes

api_client[RW]

Public Class Methods

new(api_client = ApiClient.default) click to toggle source
# File lib/vsphere-automation-appliance/api/networking_firewall_inbound_api.rb, line 16
def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Public Instance Methods

get(opts = {}) click to toggle source

Get the ordered list of firewall rules. Within the list of traffic rules, rules are processed in order of appearance, from top to bottom. When a connection matches a firewall rule, further processing for the connection stops, and the appliance ignores any additional firewall rules you have set. @param [Hash] opts the optional parameters @return [ApplianceNetworkingFirewallInboundResult|VapiStdErrorsErrorError|]

# File lib/vsphere-automation-appliance/api/networking_firewall_inbound_api.rb, line 22
def get(opts = {})
  data, _status_code, _headers = get_with_http_info(opts)
  data
end
get_with_http_info(opts = {}) click to toggle source

Get the ordered list of firewall rules. Within the list of traffic rules, rules are processed in order of appearance, from top to bottom. When a connection matches a firewall rule, further processing for the connection stops, and the appliance ignores any additional firewall rules you have set. @api private @param [Hash] opts the optional parameters @return [Array<(ApplianceNetworkingFirewallInboundResult|VapiStdErrorsErrorError|, Fixnum, Hash)>] data, response status code and response headers

# File lib/vsphere-automation-appliance/api/networking_firewall_inbound_api.rb, line 31
def get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: NetworkingFirewallInboundApi.get ...'
  end
  # resource path
  local_var_path = '/appliance/networking/firewall/inbound'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['api_key']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => {
      '200' => 'Appliance::ApplianceNetworkingFirewallInboundResult',
      '400' => 'Appliance::VapiStdErrorsErrorError',
    })
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: NetworkingFirewallInboundApi#get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
set(request_body, opts = {}) click to toggle source

Set the ordered list of firewall rules to allow or deny traffic from one or more incoming IP addresses. This overwrites the existing firewall rules and creates a new rule list. Within the list of traffic rules, rules are processed in order of appearance, from top to bottom. For example, the list of rules can be as follows: <table> <tr> <th>Address</th><th>Prefix</th><th>Interface Name</th><th>Policy</th> </tr> <tr> <td>10.112.0.1</td><td>0</td><td>*</td><td>REJECT</td> </tr> <tr> <td>10.112.0.1</td><td>0</td><td>nic0</td><td>ACCEPT</td> </tr> </table> In the above example, the first rule drops all packets originating from 10.112.0.1 and
the second rule accepts all packets originating from 10.112.0.1 only on nic0. In effect, the second rule is always ignored which is not desired, hence the order has to be swapped. When a connection matches a firewall rule, further processing for the connection stops, and the appliance ignores any additional firewall rules you have set. @param request_body @param [Hash] opts the optional parameters @return [|VapiStdErrorsErrorError|nil]

# File lib/vsphere-automation-appliance/api/networking_firewall_inbound_api.rb, line 71
def set(request_body, opts = {})
  set_with_http_info(request_body, opts)
  nil
end
set_with_http_info(request_body, opts = {}) click to toggle source

Set the ordered list of firewall rules to allow or deny traffic from one or more incoming IP addresses. This overwrites the existing firewall rules and creates a new rule list. Within the list of traffic rules, rules are processed in order of appearance, from top to bottom. For example, the list of rules can be as follows: &lt;table&gt; &lt;tr&gt; &lt;th&gt;Address&lt;/th&gt;&lt;th&gt;Prefix&lt;/th&gt;&lt;th&gt;Interface Name&lt;/th&gt;&lt;th&gt;Policy&lt;/th&gt; &lt;/tr&gt; &lt;tr&gt; &lt;td&gt;10.112.0.1&lt;/td&gt;&lt;td&gt;0&lt;/td&gt;&lt;td&gt;*&lt;/td&gt;&lt;td&gt;REJECT&lt;/td&gt; &lt;/tr&gt; &lt;tr&gt; &lt;td&gt;10.112.0.1&lt;/td&gt;&lt;td&gt;0&lt;/td&gt;&lt;td&gt;nic0&lt;/td&gt;&lt;td&gt;ACCEPT&lt;/td&gt; &lt;/tr&gt; &lt;/table&gt; In the above example, the first rule drops all packets originating from 10.112.0.1 and&lt;br&gt; the second rule accepts all packets originating from 10.112.0.1 only on nic0. In effect, the second rule is always ignored which is not desired, hence the order has to be swapped. When a connection matches a firewall rule, further processing for the connection stops, and the appliance ignores any additional firewall rules you have set. @api private @param request_body @param [Hash] opts the optional parameters @return [Array<(|VapiStdErrorsErrorError|nil, Fixnum, Hash)>] nil, response status code and response headers

# File lib/vsphere-automation-appliance/api/networking_firewall_inbound_api.rb, line 81
def set_with_http_info(request_body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: NetworkingFirewallInboundApi.set ...'
  end
  # verify the required parameter 'request_body' is set
  if @api_client.config.client_side_validation && request_body.nil?
    fail ArgumentError, "Missing the required parameter 'request_body' when calling NetworkingFirewallInboundApi.set"
  end
  # resource path
  local_var_path = '/appliance/networking/firewall/inbound'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(request_body)
  auth_names = ['api_key']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: NetworkingFirewallInboundApi#set\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end