valitydev/salt
14
0
Fork 0
mirror of https://github.com/valitydev/salt.git synced 2024-11-08 09:23:56 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

minor doc tweaks for salt.states.smartos

Browse Source
This commit is contained in:
Jorge Schrauwen 2015-11-24 12:45:13 +00:00
parent e360d70e8c
commit 8557c9ec42
1 changed files with 13 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
salt/states/smartos.py
View File

@ -76,11 +76,11 @@ Management of SmartOS Standalone Compute Nodes
.. note:: .. note::
Keep in mind that when removing entries from vmconfig they will not get Keep in mind that when removing properties from vmconfig they will not get
removed from the vm's current configuration, for nics, disk, tags, ... they removed from the vm's current configuration, except for nics, disk, tags, ...
get removed as via add_*, set_*, update_*, and remove_*. Other properties they get removed via add_*, set_*, update_*, and remove_*. Properties must
must be manually reset to their default value just like when using vmadm be manually reset to their default value.
update. The same behavior as when using 'vmadm update'.
''' '''
from __future__ import absolute_import from __future__ import absolute_import
@ -199,7 +199,7 @@ def _get_instance_changes(current, state):
def config_present(name, value): def config_present(name, value):
''' '''
Ensure configuration property is present in /usbkey/config Ensure configuration property is set to value in /usbkey/config
name : string name : string
name of property name of property
@ -425,19 +425,19 @@ def vm_present(name, vmconfig, config=None):
.. note:: .. note::
State ID is used as hostname. Hostnames should be unique. State ID is used as hostname. Hostnames must be unique.
.. note:: .. note::
If hostname is provided in vmconfig, this hostname will be used and not the state id. If hostname is provided in vmconfig this will take president over the State ID.
This allows multiple states to be applied to the same vm. This allows multiple states to be applied to the same vm.
.. note:: .. note::
Instances for the follow properties should have unique ids. The following instances should have a unique ID.
- nic : mac - nic : mac
- disk : path or diskN for zvols
- filesystem: target - filesystem: target
- disk : path or diskN for zvols
e.g. disk0 will be the first disk added, disk1 the 2nd,... e.g. disk0 will be the first disk added, disk1 the 2nd,...
@ -780,7 +780,7 @@ def vm_absent(name, archive=False):
.. note:: .. note::
State ID is used as hostname. Hostnames should be unique. State ID is used as hostname. Hostnames must be unique.
''' '''
name = name.lower() name = name.lower()
@ -823,7 +823,7 @@ def vm_running(name):
.. note:: .. note::
State ID is used as hostname. Hostnames should be unique. State ID is used as hostname. Hostnames must be unique.
''' '''
name = name.lower() name = name.lower()
@ -858,7 +858,7 @@ def vm_stopped(name):
.. note:: .. note::
State ID is used as hostname. Hostnames should be unique. State ID is used as hostname. Hostnames must be unique.
''' '''
name = name.lower() name = name.lower()