ieisystem.inmanage.edit_service module – Set service settings
Note
This module is part of the ieisystem.inmanage collection (version 2.0.0).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install ieisystem.inmanage
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: ieisystem.inmanage.edit_service
.
New in ieisystem.inmanage 1.0.0
Synopsis
Set service settings on ieisystem Server.
Requirements
The below requirements are needed on the host that executes this module.
Python 3.7+
inManage
Parameters
Parameter |
Comments |
---|---|
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. |
|
It shows the interface in which service is running. The user can choose any one of the available interfaces. Only the M5 model supports this parameter. Choices:
|
|
Used to configure non secure port number for the service. Port value ranges from 1 to 65535. |
|
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable |
|
A dict object containing connection details. |
|
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. |
|
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable |
|
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable |
|
Used to configure secure port number for the service. Port value ranges from 1 to 65535. |
|
Displays service name of the selected slot(readonly). The vnc option is not supported in M5. The fd-media/telnet/snmp option is not supported in M6. Choices:
|
|
Displays the current status of the service, either active or inactive state. Check this option to start the inactive service. Choices:
|
|
Displays the session timeout value of the service. For web, SSH and telnet service, user can configure the session timeout value. Web timeout value ranges from 300 to 1800 seconds. SSH and Telnet timeout value ranges from 60 to 1800 seconds. Timeout value should be in multiples of 60 seconds. |
|
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable |
Notes
Note
Does not support
check_mode
.
Examples
- name: Edit service test
hosts: inmanage
connection: local
gather_facts: false
vars:
inmanage:
host: "{{ ansible_ssh_host }}"
username: "{{ username }}"
password: "{{ password }}"
tasks:
- name: "Edit kvm"
ieisystem.inmanage.edit_service:
service_name: "kvm"
state: "active"
timeout: "1200"
provider: "{{ inmanage }}"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Check to see if a change was made on the device. Returned: always |
|
Messages returned after module execution. Returned: always |
|
Status after module execution. Returned: always |