| Server IP : 85.214.239.14 / Your IP : 18.222.115.150 Web Server : Apache/2.4.62 (Debian) System : Linux h2886529.stratoserver.net 4.9.0 #1 SMP Tue Jan 9 19:45:01 MSK 2024 x86_64 User : www-data ( 33) PHP Version : 7.4.18 Disable Function : pcntl_alarm,pcntl_fork,pcntl_waitpid,pcntl_wait,pcntl_wifexited,pcntl_wifstopped,pcntl_wifsignaled,pcntl_wifcontinued,pcntl_wexitstatus,pcntl_wtermsig,pcntl_wstopsig,pcntl_signal,pcntl_signal_get_handler,pcntl_signal_dispatch,pcntl_get_last_error,pcntl_strerror,pcntl_sigprocmask,pcntl_sigwaitinfo,pcntl_sigtimedwait,pcntl_exec,pcntl_getpriority,pcntl_setpriority,pcntl_async_signals,pcntl_unshare, MySQL : OFF | cURL : OFF | WGET : ON | Perl : ON | Python : ON | Sudo : ON | Pkexec : OFF Directory : /lib/python3/dist-packages/ansible_collections/lowlydba/sqlserver/plugins/modules/ |
Upload File : |
#!/usr/bin/python
# -*- coding: utf-8 -*-
# (c) 2022, John McCall (@lowlydba)
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
DOCUMENTATION = r'''
---
module: tcp_port
short_description: Sets the TCP port for the instance
description:
- Sets the TCP port for a SQL Server instance.
version_added: 0.10.0
options:
username:
description:
- Username for alternative credential to authenticate with Windows.
type: str
required: false
password:
description:
- Password for alternative credential to authenticate with Windows.
type: str
required: false
port:
description:
- Port for SQL Server to listen on.
type: int
required: true
ip_address:
description:
- IPv4 address.
type: str
required: false
force:
description:
- Restart SQL Server and SQL Agent services automatically.
type: bool
required: false
default: false
version_added: 1.2.0
author: "John McCall (@lowlydba)"
requirements:
- L(dbatools,https://www.powershellgallery.com/packages/dbatools/) PowerShell module
extends_documentation_fragment:
- lowlydba.sqlserver.sql_credentials
- lowlydba.sqlserver.attributes.check_mode
- lowlydba.sqlserver.attributes.platform_win
'''
EXAMPLES = r'''
- name: Set the default port
lowlydba.sqlserver.tcp_port:
sql_instance: sql-01.myco.io
port: 1433
- name: Set a non-standard default port
lowlydba.sqlserver.tcp_port:
sql_instance: sql-01.myco.io
port: 1933
'''
RETURN = r'''
data:
description:
- Output from the C(Set-DbaTcpPort) function.
- RestartRequired returned if the change requires a service restart to take effect.
returned: success, but not in check_mode.
type: dict
'''