Class: Ansible::Ruby::Modules::Oneandone_firewall_policy

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/cloud/oneandone/oneandone_firewall_policy.rb

Overview

Create, remove, reconfigure, update firewall policies. This module has a dependency on 1and1 >= 1.0

Instance Method Summary collapse

Methods inherited from Base

#ansible_name, #to_h

Methods inherited from Ansible::Ruby::Models::Base

attr_option, attr_options, attribute, fix_inclusion, #initialize, remove_existing_validations, #to_h, validates

Constructor Details

This class inherits a constructor from Ansible::Ruby::Models::Base

Instance Method Details

#add_rules ⇒ Array<Hash>, ...

Returns A list of rules that will be added to an existing firewall policy. It is syntax is the same as the one used for rules parameter. Used in combination with update state.

Returns:

  • (Array<Hash>, Hash, nil) —

    A list of rules that will be added to an existing firewall policy. It is syntax is the same as the one used for rules parameter. Used in combination with update state.



43
 
# File 'lib/ansible/ruby/modules/generated/cloud/oneandone/oneandone_firewall_policy.rb', line 43

attribute :add_rules

#add_server_ips ⇒ Array<String>, ...

Returns A list of server identifiers (id or name) to be assigned to a firewall policy. Used in combination with update state.

Returns:

  • (Array<String>, String, nil) —

    A list of server identifiers (id or name) to be assigned to a firewall policy. Used in combination with update state.



35
 
# File 'lib/ansible/ruby/modules/generated/cloud/oneandone/oneandone_firewall_policy.rb', line 35

attribute :add_server_ips

#api_url ⇒ Object?

Returns Custom API URL. Overrides the ONEANDONE_API_URL environement variable.

Returns:

  • (Object, nil) —

    Custom API URL. Overrides the ONEANDONE_API_URL environement variable.



20
 
# File 'lib/ansible/ruby/modules/generated/cloud/oneandone/oneandone_firewall_policy.rb', line 20

attribute :api_url

#auth_token ⇒ String

Returns Authenticating API token provided by 1&1.

Returns:

  • (String) —

    Authenticating API token provided by 1&1.



16
 
# File 'lib/ansible/ruby/modules/generated/cloud/oneandone/oneandone_firewall_policy.rb', line 16

attribute :auth_token

#description ⇒ String?

Returns Firewall policy description. maxLength=256.

Returns:

  • (String, nil) —

    Firewall policy description. maxLength=256



51
 
# File 'lib/ansible/ruby/modules/generated/cloud/oneandone/oneandone_firewall_policy.rb', line 51

attribute :description

#firewall_policy ⇒ String

Returns The identifier (id or name) of the firewall policy used with update state.

Returns:

  • (String) —

    The identifier (id or name) of the firewall policy used with update state.



27
 
# File 'lib/ansible/ruby/modules/generated/cloud/oneandone/oneandone_firewall_policy.rb', line 27

attribute :firewall_policy

#name ⇒ String

Returns Firewall policy name used with present state. Used as identifier (id or name) when used with absent state. maxLength=128.

Returns:

  • (String) —

    Firewall policy name used with present state. Used as identifier (id or name) when used with absent state. maxLength=128



23
 
# File 'lib/ansible/ruby/modules/generated/cloud/oneandone/oneandone_firewall_policy.rb', line 23

attribute :name

#remove_rules ⇒ Array<String>, ...

Returns A list of rule ids that will be removed from an existing firewall policy. Used in combination with update state.

Returns:

  • (Array<String>, String, nil) —

    A list of rule ids that will be removed from an existing firewall policy. Used in combination with update state.



47
 
# File 'lib/ansible/ruby/modules/generated/cloud/oneandone/oneandone_firewall_policy.rb', line 47

attribute :remove_rules

#remove_server_ips ⇒ Array<String>, ...

Returns A list of server IP ids to be unassigned from a firewall policy. Used in combination with update state.

Returns:

  • (Array<String>, String, nil) —

    A list of server IP ids to be unassigned from a firewall policy. Used in combination with update state.



39
 
# File 'lib/ansible/ruby/modules/generated/cloud/oneandone/oneandone_firewall_policy.rb', line 39

attribute :remove_server_ips

#rules ⇒ Array<Hash>, ...

Returns A list of rules that will be set for the firewall policy. Each rule must contain protocol parameter, in addition to three optional parameters (port_from, port_to, and source).

Returns:

  • (Array<Hash>, Hash, nil) —

    A list of rules that will be set for the firewall policy. Each rule must contain protocol parameter, in addition to three optional parameters (port_from, port_to, and source)



31
 
# File 'lib/ansible/ruby/modules/generated/cloud/oneandone/oneandone_firewall_policy.rb', line 31

attribute :rules

#state ⇒ :present, ...

Returns Define a firewall policy state to create, remove, or update.

Returns:

  • (:present, :absent, :update, nil) —

    Define a firewall policy state to create, remove, or update.



12
 
# File 'lib/ansible/ruby/modules/generated/cloud/oneandone/oneandone_firewall_policy.rb', line 12

attribute :state

#wait ⇒ :yes, ...

Returns wait for the instance to be in state ‘running’ before returning.

Returns:

  • (:yes, :no, nil) —

    wait for the instance to be in state ‘running’ before returning



55
 
# File 'lib/ansible/ruby/modules/generated/cloud/oneandone/oneandone_firewall_policy.rb', line 55

attribute :wait

#wait_interval ⇒ Integer?

Returns Defines the number of seconds to wait when using the _wait_for methods.

Returns:

  • (Integer, nil) —

    Defines the number of seconds to wait when using the _wait_for methods



63
 
# File 'lib/ansible/ruby/modules/generated/cloud/oneandone/oneandone_firewall_policy.rb', line 63

attribute :wait_interval

#wait_timeout ⇒ Integer?

Returns how long before wait gives up, in seconds.

Returns:

  • (Integer, nil) —

    how long before wait gives up, in seconds



59
 
# File 'lib/ansible/ruby/modules/generated/cloud/oneandone/oneandone_firewall_policy.rb', line 59

attribute :wait_timeout