Class: Ansible::Ruby::Modules::Bigip_policy

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/network/f5/bigip_policy.rb

Overview

Manages general policy configuration on a BIG-IP. This module is best used in conjunction with the C(bigip_policy_rule) module. This module can handle general configuration like setting the draft state of the policy, the description, and things unrelated to the policy rules themselves. It is also the first module that should be used when creating rules as the C(bigip_policy_rule) module requires a policy parameter.

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

#description ⇒ Object?

Returns The description to attach to the policy.,This parameter is only supported on versions of BIG-IP >= 12.1.0. On earlier versions it will simply be ignored.

Returns:

  • (Object, nil) —

    The description to attach to the policy.,This parameter is only supported on versions of BIG-IP >= 12.1.0. On earlier versions it will simply be ignored.



12
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_policy.rb', line 12

attribute :description

#name ⇒ String

Returns The name of the policy to create.

Returns:

  • (String) —

    The name of the policy to create.



15
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_policy.rb', line 15

attribute :name

#partition ⇒ String?

Returns Device partition to manage resources on.

Returns:

  • (String, nil) —

    Device partition to manage resources on.



31
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_policy.rb', line 31

attribute :partition

#rules ⇒ Array<String>, ...

Returns Specifies a list of rules that you want associated with this policy. The order of this list is the order they will be evaluated by BIG-IP. If the specified rules do not exist (for example when creating a new policy) then they will be created.,The C(conditions) for a default rule are C(all).,The C(actions) for a default rule are C(ignore).,The C(bigip_policy_rule) module can be used to create and edit existing and new rules.

Returns:

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

    Specifies a list of rules that you want associated with this policy. The order of this list is the order they will be evaluated by BIG-IP. If the specified rules do not exist (for example when creating a new policy) then they will be created.,The C(conditions) for a default rule are C(all).,The C(actions) for a default rule are C(ignore).,The C(bigip_policy_rule) module can be used to create and edit existing and new rules.



27
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_policy.rb', line 27

attribute :rules

#state ⇒ :present, ...

Returns When C(state) is C(present), ensures that the policy exists and is published. When C(state) is C(absent), ensures that the policy is removed, even if it is currently drafted.,When C(state) is C(draft), ensures that the policy exists and is drafted. When modifying rules, it is required that policies first be in a draft.,Drafting is only supported on versions of BIG-IP >= 12.1.0. On versions prior to that, specifying a C(state) of C(draft) will raise an error.

Returns:

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

    When C(state) is C(present), ensures that the policy exists and is published. When C(state) is C(absent), ensures that the policy is removed, even if it is currently drafted.,When C(state) is C(draft), ensures that the policy exists and is drafted. When modifying rules, it is required that policies first be in a draft.,Drafting is only supported on versions of BIG-IP >= 12.1.0. On versions prior to that, specifying a C(state) of C(draft) will raise an error.



19
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_policy.rb', line 19

attribute :state

#strategy ⇒ :first, ...

Returns Specifies the method to determine which actions get executed in the case where there are multiple rules that match. When creating new policies, the default is C(first).,This module does not allow you to specify the C(best) strategy to use. It will choose the system default (C(/Common/best-match)) for you instead.

Returns:

  • (:first, :all, :best, nil) —

    Specifies the method to determine which actions get executed in the case where there are multiple rules that match. When creating new policies, the default is C(first).,This module does not allow you to specify the C(best) strategy to use. It will choose the system default (C(/Common/best-match)) for you instead.



23
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_policy.rb', line 23

attribute :strategy