salt.modules.win_system¶
Support for reboot, shutdown, etc
-
salt.modules.win_system.
get_computer_desc
()¶ Get the Windows computer description
CLI Example:
salt 'minion-id' system.get_computer_desc
-
salt.modules.win_system.
get_computer_name
()¶ Get the Windows computer name
CLI Example:
salt 'minion-id' system.get_computer_name
-
salt.modules.win_system.
get_pending_computer_name
()¶ Get a pending computer name. If the computer name has been changed, and the change is pending a system reboot, this function will return the pending computer name. Otherwise,
None
will be returned. If there was an error retrieving the pending computer name,False
will be returned, and an error message will be logged to the minion log.CLI Example:
salt 'minion-id' system.get_pending_computer_name
-
salt.modules.win_system.
get_system_date
()¶ Get the Windows system date
CLI Example:
salt '*' system.get_system_date
-
salt.modules.win_system.
get_system_time
()¶ Get the Windows system time
CLI Example:
salt '*' system.get_system_time
-
salt.modules.win_system.
halt
(timeout=5)¶ Halt a running system
CLI Example:
salt '*' system.halt
-
salt.modules.win_system.
init
(runlevel)¶ Change the system runlevel on sysV compatible systems
CLI Example:
salt '*' system.init 3
-
salt.modules.win_system.
join_domain
(domain, username, passwd, ou, acct_exists=False)¶ Join a computer the an Active Directory domain
CLI Example:
salt 'minion-id' system.join_domain 'mydomain.local' 'myusername' 'mysecretpasswd' 'OU=MyClients;OU=MyOrg;DC=myDom;DC=local'
-
salt.modules.win_system.
poweroff
(timeout=5)¶ Poweroff a running system
CLI Example:
salt '*' system.poweroff
-
salt.modules.win_system.
reboot
(timeout=5)¶ Reboot the system
CLI Example:
salt '*' system.reboot
-
salt.modules.win_system.
set_computer_desc
(desc)¶ Set the Windows computer description
CLI Example:
salt 'minion-id' system.set_computer_desc 'This computer belongs to Dave!'
-
salt.modules.win_system.
set_computer_name
(name)¶ Set the Windows computer name
CLI Example:
salt 'minion-id' system.set_computer_name 'DavesComputer'
-
salt.modules.win_system.
set_system_date
(newdate)¶ Set the Windows system date. Use <mm-dd-yy> format for the date.
CLI Example:
salt '*' system.set_system_date '03-28-13'
-
salt.modules.win_system.
set_system_time
(newtime)¶ Set the Windows system time
CLI Example:
salt '*' system.set_system_time '11:31:15 AM'
-
salt.modules.win_system.
shutdown
(timeout=5)¶ Shutdown a running system
CLI Example:
salt '*' system.shutdown
-
salt.modules.win_system.
shutdown_hard
()¶ Shutdown a running system with no timeout or warning
CLI Example:
salt '*' system.shutdown_hard
-
salt.modules.win_system.
start_time_service
()¶ Start the Windows time service
CLI Example:
salt '*' system.start_time_service
-
salt.modules.win_system.
stop_time_service
()¶ Stop the Windows time service
CLI Example:
salt '*' system.stop_time_service