Class: Ansible::Ruby::Modules::Aci_rest

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

Overview

Enables the management of the Cisco ACI fabric through direct access to the Cisco APIC REST API. Thanks to the idempotent nature of the APIC, this module is idempotent and reports changes.

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

#content ⇒ String, ...

Returns When used instead of C(src), sets the payload of the API request directly.,This may be convenient to template simple requests.,For anything complex use the C(template) lookup plugin (see examples) or the M(template) module with parameter C(src).

Returns:

  • (String, Hash, nil) —

    When used instead of C(src), sets the payload of the API request directly.,This may be convenient to template simple requests.,For anything complex use the C(template) lookup plugin (see examples) or the M(template) module with parameter C(src).



21
 
# File 'lib/ansible/ruby/modules/generated/network/aci/aci_rest.rb', line 21

attribute :content

#method ⇒ :delete, ...

Returns The HTTP method of the request.,Using C(delete) is typically used for deleting objects.,Using C(get) is typically used for querying objects.,Using C(post) is typically used for modifying objects.

Returns:

  • (:delete, :get, :post, nil) —

    The HTTP method of the request.,Using C(delete) is typically used for deleting objects.,Using C(get) is typically used for querying objects.,Using C(post) is typically used for modifying objects.



13
 
# File 'lib/ansible/ruby/modules/generated/network/aci/aci_rest.rb', line 13

attribute :method

#path ⇒ Array<String>, String

Returns URI being used to execute API calls.,Must end in C(.xml) or C(.json).

Returns:

  • (Array<String>, String) —

    URI being used to execute API calls.,Must end in C(.xml) or C(.json).



17
 
# File 'lib/ansible/ruby/modules/generated/network/aci/aci_rest.rb', line 17

attribute :path

#src ⇒ String?

Returns Name of the absolute path of the filname that includes the body of the HTTP request being sent to the ACI fabric.,If you require a templated payload, use the C(content) parameter together with the C(template) lookup plugin, or use M(template).

Returns:

  • (String, nil) —

    Name of the absolute path of the filname that includes the body of the HTTP request being sent to the ACI fabric.,If you require a templated payload, use the C(content) parameter together with the C(template) lookup plugin, or use M(template).



25
 
# File 'lib/ansible/ruby/modules/generated/network/aci/aci_rest.rb', line 25

attribute :src