summaryrefslogtreecommitdiff
path: root/cloudinit/config/cc_update_hostname.py
diff options
context:
space:
mode:
Diffstat (limited to 'cloudinit/config/cc_update_hostname.py')
-rw-r--r--cloudinit/config/cc_update_hostname.py25
1 files changed, 25 insertions, 0 deletions
diff --git a/cloudinit/config/cc_update_hostname.py b/cloudinit/config/cc_update_hostname.py
index 5b78afe1..315b7b6f 100644
--- a/cloudinit/config/cc_update_hostname.py
+++ b/cloudinit/config/cc_update_hostname.py
@@ -18,6 +18,31 @@
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
+"""
+Update Hostname
+---------------
+**Summary:** update hostname and fqdn
+
+This module will update the system hostname and fqdn. If ``preserve_hostname``
+is set, then the hostname will not be altered.
+
+.. note::
+ for instructions on specifying hostname and fqdn, see documentation for
+ ``cc_set_hostname``
+
+**Internal name:** ``cc_update_hostname``
+
+**Module frequency:** per always
+
+**Supported distros:** all
+
+**Config keys**::
+
+ preserve_hostname: <true/false>
+ fqdn: <fqdn>
+ hostname: <fqdn/hostname>
+"""
+
import os
from cloudinit.settings import PER_ALWAYS