Class: Ansible::Ruby::Modules::Fmgr_script

Inherits:

Base

• Object
• Ansible::Ruby::Models::Base
• Base
• Ansible::Ruby::Modules::Fmgr_script

Defined in:

lib/ansible/ruby/modules/generated/network/fortimanager/fmgr_script.rb

Overview

Create/edit/delete scripts and execute the scripts on the FortiManager using jsonrpc API

Instance Method Summary

• #adom ⇒ String

  The administrative domain (admon) the configuration belongs to.

• #host ⇒ String

  The FortiManager’s Address.

• #password ⇒ String^?

  The password associated with the username account.

• #script_content ⇒ String^?

  The script content that will be executed.

• #script_description ⇒ String^?

  The description of the script.

• #script_name ⇒ String

  The name of the script.

• #script_package ⇒ Object^?

  (datasource) Policy package object to run the script against.

• #script_scope ⇒ Array<String>, ...

  (datasource) The devices that the script will run on, can have both device member and device group member.

• #script_target ⇒ String^?

  The target of the script to be run.

• #script_type ⇒ String^?

  The type of script (CLI or TCL).

• #state ⇒ :present, ...

  The desired state of the specified object.,present - will create a script.,execute - execute the scipt.,delete - delete the script.

• #username ⇒ String

  The username to log into the FortiManager.

• #vdom ⇒ Object^?

  The virtual domain (vdom) the configuration belongs to.

Methods inherited from Base

#ansible_name, #to_h

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

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

Constructor Details

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

Instance Method Details

#adom ⇒ String

Returns The administrative domain (admon) the configuration belongs to.

Returns:

• (String) —

  The administrative domain (admon) the configuration belongs to

# File 'lib/ansible/ruby/modules/generated/network/fortimanager/fmgr_script.rb', line 12

attribute :adom

#host ⇒ String

Returns The FortiManager’s Address.

Returns:

• (String) —

  The FortiManager’s Address.

# File 'lib/ansible/ruby/modules/generated/network/fortimanager/fmgr_script.rb', line 19

attribute :host

#password ⇒ String^?

Returns The password associated with the username account.

Returns:

• (String, nil) —

  The password associated with the username account.

# File 'lib/ansible/ruby/modules/generated/network/fortimanager/fmgr_script.rb', line 27

attribute :password

#script_content ⇒ String^?

Returns The script content that will be executed.

Returns:

• (String, nil) —

  The script content that will be executed.

# File 'lib/ansible/ruby/modules/generated/network/fortimanager/fmgr_script.rb', line 51

attribute :script_content

#script_description ⇒ String^?

Returns The description of the script.

Returns:

• (String, nil) —

  The description of the script.

# File 'lib/ansible/ruby/modules/generated/network/fortimanager/fmgr_script.rb', line 47

attribute :script_description

#script_name ⇒ String

Returns The name of the script.

Returns:

• (String) —

  The name of the script.

# File 'lib/ansible/ruby/modules/generated/network/fortimanager/fmgr_script.rb', line 35

attribute :script_name

#script_package ⇒ Object^?

Returns (datasource) Policy package object to run the script against.

Returns:

• (Object, nil) —

  (datasource) Policy package object to run the script against

# File 'lib/ansible/ruby/modules/generated/network/fortimanager/fmgr_script.rb', line 59

attribute :script_package

#script_scope ⇒ Array<String>, ...

Returns (datasource) The devices that the script will run on, can have both device member and device group member.

Returns:

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

  (datasource) The devices that the script will run on, can have both device member and device group member.

# File 'lib/ansible/ruby/modules/generated/network/fortimanager/fmgr_script.rb', line 55

attribute :script_scope

#script_target ⇒ String^?

Returns The target of the script to be run.

Returns:

• (String, nil) —

  The target of the script to be run.

# File 'lib/ansible/ruby/modules/generated/network/fortimanager/fmgr_script.rb', line 43

attribute :script_target

#script_type ⇒ String^?

Returns The type of script (CLI or TCL).

Returns:

• (String, nil) —

  The type of script (CLI or TCL).

# File 'lib/ansible/ruby/modules/generated/network/fortimanager/fmgr_script.rb', line 39

attribute :script_type

#state ⇒ :present, ...

Returns The desired state of the specified object.,present - will create a script.,execute - execute the scipt.,delete - delete the script.

Returns:

• (:present, :execute, :delete, nil) —

  The desired state of the specified object.,present - will create a script.,execute - execute the scipt.,delete - delete the script.

# File 'lib/ansible/ruby/modules/generated/network/fortimanager/fmgr_script.rb', line 31

attribute :state

#username ⇒ String

Returns The username to log into the FortiManager.

Returns:

• (String) —

  The username to log into the FortiManager

# File 'lib/ansible/ruby/modules/generated/network/fortimanager/fmgr_script.rb', line 23

attribute :username

#vdom ⇒ Object^?

Returns The virtual domain (vdom) the configuration belongs to.

Returns:

• (Object, nil) —

  The virtual domain (vdom) the configuration belongs to

# File 'lib/ansible/ruby/modules/generated/network/fortimanager/fmgr_script.rb', line 16

attribute :vdom