- Docs »
- inspur.sm.edit_service – Set service settings.
-
You are reading the latest community version of the Ansible documentation. Red Hat subscribers, select 2.9 in the version selection to the left for the most recent Red Hat release.
inspur.sm.edit_service – Set service settings.
Note
This plugin is part of the inspur.sm collection (version 1.1.2).
To install it use: ansible-galaxy collection install inspur.sm
.
To use it in a playbook, specify: inspur.sm.edit_service
.
New in version 0.1.0: of inspur.sm
Parameter |
Choices/Defaults |
Comments |
host
string
|
|
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.
|
interface
string
|
Choices:
- eth0
- eth1
- both
- bond0
|
It shows the interface in which service is running.
The user can choose any one of the available interfaces.
|
non_secure_port
integer
|
|
Used to configure non secure port number for the service.
Port value ranges from 1 to 65535.
|
password
string
|
|
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 ANSIBLE_NET_PASSWORD will be used instead.
|
provider
dictionary
|
|
A dict object containing connection details.
|
|
host
string
|
|
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.
|
|
password
string
|
|
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 ANSIBLE_NET_PASSWORD will be used instead.
|
|
username
string
|
|
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 ANSIBLE_NET_USERNAME will be used instead.
|
secure_port
integer
|
|
Used to configure secure port number for the service.
Port value ranges from 1 to 65535.
|
service_name
string
/ required
|
Choices:
- web
- kvm
- cd-media
- fd-media
- hd-media
- ssh
- telnet
- solssh
- snmp
|
Displays service name of the selected slot(readonly).
|
state
string
|
|
Displays the current status of the service, either active or inactive state.
Check this option to start the inactive service.
|
timeout
integer
|
|
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.
|
username
string
|
|
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 ANSIBLE_NET_USERNAME will be used instead.
|
- name: Edit service test
hosts: ism
connection: local
gather_facts: no
vars:
ism:
host: "{{ ansible_ssh_host }}"
username: "{{ username }}"
password: "{{ password }}"
tasks:
- name: "Edit kvm"
inspur.sm.edit_service:
service_name: "kvm"
state: "active"
timeout: "1200"
provider: "{{ ism }}"
Common return values are documented here, the following are the fields unique to this module:
Key |
Returned |
Description |
changed
boolean
|
always |
Check to see if a change was made on the device.
|
message
string
|
always |
Messages returned after module execution.
|
state
string
|
always |
Status after module execution.
|