Class: Ansible::Ruby::Modules::Ftd_configuration

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

Overview

Manages configuration on Cisco FTD devices including creating, updating, removing configuration objects, scheduling and staring jobs, deploying pending changes, etc. All operation are performed over REST API.

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

#data ⇒ Hash?

Returns Key-value pairs that should be sent as body parameters in a REST API call.

Returns:

  • (Hash, nil) —

    Key-value pairs that should be sent as body parameters in a REST API call



16
 
# File 'lib/ansible/ruby/modules/generated/network/ftd/ftd_configuration.rb', line 16

attribute :data

#filters ⇒ Object?

Returns Key-value dict that represents equality filters. Every key is a property name and value is its desired value. If multiple filters are present, they are combined with logical operator AND.

Returns:

  • (Object, nil) —

    Key-value dict that represents equality filters. Every key is a property name and value is its desired value. If multiple filters are present, they are combined with logical operator AND.



31
 
# File 'lib/ansible/ruby/modules/generated/network/ftd/ftd_configuration.rb', line 31

attribute :filters

#operation ⇒ String

Returns The name of the operation to execute. Commonly, the operation starts with ‘add’, ‘edit’, ‘get’ or ‘delete’ verbs, but can have an arbitrary name too.

Returns:

  • (String) —

    The name of the operation to execute. Commonly, the operation starts with ‘add’, ‘edit’, ‘get’ or ‘delete’ verbs, but can have an arbitrary name too.



12
 
# File 'lib/ansible/ruby/modules/generated/network/ftd/ftd_configuration.rb', line 12

attribute :operation

#path_params ⇒ Hash?

Returns Key-value pairs that should be sent as path parameters in a REST API call.

Returns:

  • (Hash, nil) —

    Key-value pairs that should be sent as path parameters in a REST API call.



23
 
# File 'lib/ansible/ruby/modules/generated/network/ftd/ftd_configuration.rb', line 23

attribute :path_params

#query_params ⇒ Object?

Returns Key-value pairs that should be sent as query parameters in a REST API call.

Returns:

  • (Object, nil) —

    Key-value pairs that should be sent as query parameters in a REST API call.



20
 
# File 'lib/ansible/ruby/modules/generated/network/ftd/ftd_configuration.rb', line 20

attribute :query_params

#register_as ⇒ String?

Returns Specifies Ansible fact name that is used to register received response from the FTD device.

Returns:

  • (String, nil) —

    Specifies Ansible fact name that is used to register received response from the FTD device.



27
 
# File 'lib/ansible/ruby/modules/generated/network/ftd/ftd_configuration.rb', line 27

attribute :register_as