/usr/lib/python3/dist-packages/cloudinit/sources/__pycache__
Edit: /usr/lib/python3/dist-packages/cloudinit/sources/__pycache__/DataSourceVMware.cpython-310.pyc (28411B)
o
th @ s d Z ddlZddlZddlZddlZddlZddlZddlZddlZddl Z ddl
Z
ddl m Z m
Z
ddlmZmZmZmZmZmZ ddlmZmZmZ ddlmZ ddlm Z ddl m Z m Z m Z d Z!e"e#Z$d
Z%d Z&d Z'd
Z(dZ)dZ*dZ+dZ,dZ-dZ.dZ/dZ0dZ1dZ2dZ3ej4ej5ej6ej7hiZ8ej4ej6ej7hiZ9g dZ:dZ;dd Z
Z?d!d" Z@d#d$ ZAd%d& ZBd'd( ZCd)d* ZDd+d, ZEd-d. ZFd/d0 ZGd1d2 ZHd3d4 ZId5d6 ZJd7d8 ZKd9d: ZLd;d ZMdd? ZOd@dA ZPdBdC ZQdDdE ZRe?ejSffe?ejSejTffgZUdFdG ZVdHdI ZWd\dKdLZXdMdN ZYdOeZdPeZfdQdRZ[dOeZdPeZfdSdTZ\dUdV Z]dWdX Z^dYdZ Z_e#d[krEe_ dS dS )]zCloud-Init DataSource for VMware
This module provides a cloud-init datasource for VMware systems and supports
multiple transports types, including:
* EnvVars
* GuestInfo
* IMC (Guest Customization)
N)DictSet)
atomic_helperdminetnetinfosourcesutil)
EventScope EventTypeuserdata_to_events)loggers)guestcust_util)ProcessExecutionErrorsubpwhichz /sys/class/dmi/id/product_uuidzNo value foundenvvar guestinfoimcredactzcleanup-guestinfo
VMX_GUESTINFOz---z
local-ipv4z
local-ipv6zwait-on-networkipv4ipv6zcloudinit.updates.supportedzcloudinit.updates.enabled)e1000e1000evlancevmxnet2vmxnet3vrdmaz9
ENV{}=="{}", GOTO="cloudinit_hook"
GOTO="cloudinit_end"
c C s t jdd dk r | S t| S )z
cache is a wrapper around functools.cache that no-ops when Python
is <3.9, the version in which functools.cache was introduced.
N ) )sys version_info functoolscache)function r' D/usr/lib/python3/dist-packages/cloudinit/sources/DataSourceVMware.pyr% m s
r% c C s | r t dd| S d S )Nz{ID_NET_DRIVER}|) _EXTRA_HOTPLUG_UDEV_RULES_FORMATformatjoin)
driver_idsr' r' r( get_extra_hotplug_udev_rulesx s
r. c s e Zd ZdZdZeeZee Z
e e Z
d,ddZdeddf fdd Zd
d Zd d
Zdd Zdd Zdd Zdd Zedd Zdd Zdd Zed d Z d d Z d d! Z d"d# Z d$d% Z d&d' Z!d(d) Z"d*d+ Z# Z$S )-DataSourceVMwareav
Setting the hostname:
The hostname is set by way of the metadata key "local-hostname".
Setting the instance ID:
The instance ID may be set by way of the metadata key "instance-id".
However, if this value is absent then the instance ID is read
from the file /sys/class/dmi/id/product_uuid.
Configuring the network:
The network is configured by setting the metadata key "network"
with a value consistent with Network Config Versions 1 or 2,
depending on the Linux distro's version of cloud-init:
Network Config Version 1 - http://bit.ly/cloudinit-net-conf-v1
Network Config Version 2 - http://bit.ly/cloudinit-net-conf-v2
For example, CentOS 7's official cloud-init package is version
0.7.9 and does not support Network Config Version 2.
imc transport:
Either Network Config Version 1 or Network Config Version 2 is
supported which depends on the customization type.
For LinuxPrep customization, Network config Version 1 data is
parsed from the customization specification.
For CloudinitPrep customization, Network config Version 2 data
is parsed from the customization specification.
envvar and guestinfo transports:
Network Config Version 2 data is supported as long as the Linux
distro's cloud-init package is new enough to parse the data.
The metadata key "network.encoding" may be used to indicate the
format of the metadata key "network". Valid encodings are base64
and gzip+base64.
VMwareNc C sT t j| |||| i | _d | _d | _d | _t| jdft | j
dft | j dfg| _
d S )NFT)r
DataSource__init__cfgdata_access_methodrpctool
rpctool_fnDATA_ACCESS_METHOD_ENVVARget_envvar_data_fn DATA_ACCESS_METHOD_GUESTINFOget_guestinfo_data_fnDATA_ACCESS_METHOD_IMCget_imc_data_fn possible_data_access_method_list)selfsys_cfgdistropathsud_procr' r' r( r2 s
zDataSourceVMware.__init__ci_pkl_versionreturnc s t | dD ]
}t| |st| |d qt| ds!t| di t| ds;t| dt| jdft| jdft| j dfg t| dsGt
t | _ d S d S )N)r5 r6 r3 r= FTextra_hotplug_udev_rules)
super _unpicklehasattrsetattrr7 r8 r9 r: r; r< r. DEFAULT_NETWORK_DRIVERSrE )r> rC attr __class__r' r( rG s6
zDataSourceVMware._unpicklec C s t j| }d|| jf S )Nz %s [seed=%s])r r1 __str__r4 )r> rootr' r' r( rN s zDataSourceVMware.__str__c C s d\}}}| j D ] \}}}|rt sq| \}}}|s |s |r$|| _ nq| js/td dS td| tt|| _ || _
|| _ | | j sQ| j
sQ| j rSdS dS )a
_get_data loads the metadata, userdata, and vendordata from one of
the following locations in the given order:
* envvars
* guestinfo
* imc
Please note when updating this function with support for new data
transports, the order should match the order in the dscheck_VMware
function from the file ds-identify.
NNNz)failed to find a valid data access methodFzusing data access method %sT)
r= is_vmware_platformr4 LOGdebuginfo_get_subplatformprocess_metadataload_json_or_yamlmetadata userdata_rawvendordata_raw redact_keys)r> mdudvdr4 get_data_fnrequire_vmware_platformr' r' r( _get_data s0
zDataSourceVMware._get_datac C sL t | j}td| t|| j| j t| j|g| _| |
dS )a( setup(is_new_instance)
This is called before user-data and vendor-data have been processed.
Unless the datasource has set mode to 'local', then networking
per 'fallback' or per 'network_config' will have been written and
brought up the OS at this point.
zgot host-info: %sN) wait_on_networkrX rR rT advertise_local_ip_addrsr5 r6 r
mergemanydict init_extra_hotplug_udev_rulespersist_instance_data)r> is_new_instance host_infor' r' r( setup s
zDataSourceVMware.setupc C s | | dS )a activate(cfg, is_new_instance)
This is called before the init_modules will be called but after
the user-data and vendor-data have been fully processed.
The cfg is fully up to date config, it contains a merged view of
system config, datasource config, user config, vendor config.
It should be used rather than the sys_cfg passed to __init__.
is_new_instance is a boolean indicating if this is a new instance.
N)advertise_update_events)r> r3 rg r' r' r( activate? s zDataSourceVMware.activatec C sL d }| j tkr
t}n| j tkrt}n | j tkrt}ntjS d| j |df S )Nz%s (%s)rX ) r4 r7 get_guestinfo_envvar_key_namer9 get_guestinfo_key_namer; get_imc_key_namer METADATA_UNKNOWN)r> get_key_name_fnr' r' r( rU O s
z!DataSourceVMware._get_subplatformc C s | j S N)r3 r> r' r' r( get_config_objb s z DataSourceVMware.get_config_objc C sB d| j v r td ntd d| j i| j d< | j d d S )Nnetworkz using metadata network configz using fallback network configconfig)rX rR rS r@ generate_fallback_configrr r' r' r( network_confige s
z DataSourceVMware.network_configc C sJ t | j}t|di }tt |t |g}t| j|| j | j
S )Nupdates) copydeepcopydefault_update_eventsr getr rd rj supported_update_eventsr5 r6 )r> r3 default_events user_eventsenabled_eventsr' r' r( rj p s"
z(DataSourceVMware.advertise_update_eventsc C s t | }|r
|| _d S d S rq )r. get_network_driversrE )r> rulesr' r' r( re s
z.DataSourceVMware.init_extra_hotplug_udev_rulesc C s< t }| jrd| jv r| jd }dd |D }td| |S )Nznetwork-driversc S s g | ]}| d qS ) )strip).0sr' r' r(
s z8DataSourceVMware.get_network_drivers..zgot network drivers %s)rJ rX rR rT )r> network_driversr' r' r( r s
z$DataSourceVMware.get_network_driversc C s< | j r
d| j v r
| j d S tt | j d< | j d S )Nz instance-id)rX r load_text_filePRODUCT_UUID_FILE_PATHrstriplowerrr r' r' r( get_instance_id s
z DataSourceVMware.get_instance_idc C s. | j r| j tkrt rtd| dS dS )Nz"Cache fallback is allowed for : %sTF)r4 r; rQ rR rS rU rr r' r' r( check_if_fallback_is_allowed s
z-DataSourceVMware.check_if_fallback_is_allowedc C s, dD ]}|| j v rt| j | S qg S )N)zpublic-keys-datapublic_keys_dataz public-keys public_keys)rX r normalize_pubkey_data)r> key_namer' r' r( get_public_ssh_keys s
z$DataSourceVMware.get_public_ssh_keysc C sP d }t | jv r
| jt }n
t| jv r| jt }| jtkr&t|| j| j d S d S rq )REDACTrX CLEANUP_GUESTINFOr4 r9 guestinfo_redact_keysr5 r6 )r> keys_to_redactr' r' r( r[ s
z DataSourceVMware.redact_keysc C s: d\}}}t jtdrtd}td}td}|||fS )z<
check to see if there is data via env vars
rP rX userdata
vendordata)osenvironr| r guestinfo_envvar)r> r\ r] r^ r' r' r( r8 s
z#DataSourceVMware.get_envvar_data_fnc C s@ t d}t d}|r|| _t| _td| |r&|s || _t| _td| | js0td dS dd }z|| j| jW S ty } zWt td | j| |r[| j|kr[W Y d
}~dS |sit
d W Y d
}~dS t
d || _t| _z|| j| jW W Y d
}~S ty t td | j| Y W Y d
}~dS w d
}~ww )
zK
check to see if there is data via the guestinfo transport
vmtoolsdzvmware-rpctoolz discovered vmware-rpctool: %szdiscovered vmtoolsd: %szno rpctool discoveredrP c S sD d\}}}t d| td| |}td| |}td| |}|||fS )NrP zquery guestinfo with %srX r r )rR rT r )r5 r6 r\ r] r^ r' r' r( query_guestinfo s
z?DataSourceVMware.get_guestinfo_data_fn..query_guestinfoz%Failed to query guestinfo with %s: %sNz$vmtoolsd fallback option not presentzfallback to vmtoolsd) r r5 exec_vmware_rpctoolr6 rR rS
exec_vmtoolsd Exceptionr logexcrT )r> r vmware_rpctoolr errorr' r' r( r: sZ
z&DataSourceVMware.get_guestinfo_data_fnc C s d\}}}t | j}t | j}|s |s td |||fS t s(|||fS t | j}|du r7|||fS t j
|}t |}t
|\} }
| rh|rhtd t | jj| jd||| j\}}}| _n|
rz|rztd t |\}}}ntd t| |||fS )zN
check to see if there is data via vmware guest customization
rP z-Customization for VMware platform is disabledNz3Getting data via VMware customization configurationscriptszFGetting data via VMware raw cloudinit data customization configurationz1No allowed customization configuration data found)r is_vmware_cust_enabledr? is_raw_data_cust_enabledds_cfgrR rS is_cust_plugin_availableget_cust_cfg_filer pathdirnameparse_cust_cfgget_cust_cfg_typeget_data_from_imc_cust_cfgrA cloud_dir get_cpathr@ r3 #get_data_from_imc_raw_data_cust_cfgr del_dir) r> r\ r] r^ allow_vmware_custallow_raw_data_cust
cust_cfg_file cust_cfg_dircust_cfgis_vmware_cust_cfgis_raw_data_cust_cfgr' r' r( r< sL
z DataSourceVMware.get_imc_data_fnrq )%__name__
__module__ __qualname____doc__dsnamery rz SUPPORTED_UPDATE_EVENTSr} DEFAULT_UPDATE_EVENTSr{ r. rJ rE r2 intrG rN ra ri rk rU rs propertyrw rj re r% r r r r r[ r8 r: r<
__classcell__r' r' rL r( r/ s: $
9
Lr/ c C s> t d} | d u rtd dS d| vr td dS dS )Nzsystem-product-namez No system-product-name foundFvmwarezNot a VMware platformT)r
read_dmi_datarR rS r ) system_typer' r' r( rQ W s
rQ c C sv t d| | d}|dv r t d|| tt|}n|dv r.t d|| t|}nt d| |}t|S )z
decode returns the decoded string value of data
key is a string used to identify the data being decoded in log messages
z'Getting encoded data for key=%s, enc=%sN)z gzip+base64zgz+b64zDecoding %s format %s)base64b64zPlain-text data %s)rR rS r decomp_gzipr b64d
decode_binary)keyenc_typedataraw_datar' r' r( decodeb s
r c C s& t | } | } | r| tkrdS | S )a
get_none_if_empty_val returns None if the provided value, once stripped
of its trailing whitespace, is empty or equal to GUESTINFO_EMPTY_YAML_VAL.
The return value is always a string, regardless of whether the input is
a bytes class or a string.
N)r r r GUESTINFO_EMPTY_YAML_VAL)valr' r' r( get_none_if_empty_valw s
r c C sh | r|r|sdS | t}|r tt||| td| | t}|r2tt||| td| dS dS )z
advertise_local_ip_addrs gets the local IP address information from
the provided host_info map and sets the addresses in the guestinfo
namespace
Nz-advertised local ipv4 address %s in guestinfoz-advertised local ipv6 address %s in guestinfo)r|
LOCAL_IPV4guestinfo_set_valuerR rT
LOCAL_IPV6)rh r5 r6
local_ipv4
local_ipv6r' r' r( rc s
rc c C sh |r|sdS dd }|| }|r t t||| td| ||}|r0t t||| td| ||fS )a
advertise_update_events publishes the types of supported and
enabled events to guestinfo.
The string returned from this method adheres to the following
format:
SCOPE=TYPE[;TYPE][,SCOPE=TYPE[;TYPE]]
For example:
* network=boot;hotplug
* network=boot-new-instance
The only supported event scope at the moment is network, but there
may be more scopes in the future, and this format will support them.
)NNc S sJ g }| D ]\}}tdd |D }|d|d| qd|S )Nc s s | ]}t |V qd S rq )str)r
event_typer' r' r( s
zEadvertise_update_events..get_events_string..z{}={};,)itemssortedappendr+ r, )eventsevent_scopes_and_types_list event_scope event_typesevent_types_listr' r' r( get_events_string s
z2advertise_update_events..get_events_stringz3advertised supported update events in guestinfo: %sz1advertised enabled update events in guestinfo: %s)r &SUPPORTED_UPDATE_EVENTS_GUEST_INFO_KEYrR rT $ENABLED_UPDATE_EVENTS_GUEST_INFO_KEY)r} enabled_update_eventsr5 r6 r supported_events_stringenabled_events_stringr' r' r( rj s8 rj c C s t |}|r|S td| dS )z
handle_returned_guestinfo_val returns the provided value if it is
not empty or set to GUESTINFO_EMPTY_YAML_VAL, otherwise None is
returned
No value found for key %sN)r rR rS )r r r' r' r( handle_returned_guestinfo_val s
r c C s dS )Nz vmware-toolsr' r r' r' r( rn s rn c C s d| S )Nz
guestinfo.r' r r' r' r( rm s rm c C s dt | dddS )Nzvmx.._)rm upperreplacer r' r' r( rl s rl c C s, t | }|sd S t | d }tt| ||S )N .encoding)guestinfo_envvar_get_valuer rl )r r r r' r' r( r s
r c C s t | }t| tj|dS )Nr )rl r r r r| )r env_keyr' r' r( r s r c C s t | |g\}}||fS rq r r5 argstdoutstderrr' r' r( r s r c C s t | d|g\}}||fS )Nz--cmdr r r' r' r( r s r c C s4 t | ||}|s
dS t | d ||}tt| ||S )zj
guestinfo returns the guestinfo value for the provided key, decoding
the value when required
Nr )guestinfo_get_valuer rm )r r5 r6 r r r' r' r( r s
c
C s t d| z$||dt| \}}|tkr t d| n|s%t d| t| |W S tyS } z |jtkr>t d| n
t t d| | |W Y d}~dS d}~w t
yh } z
t t d| | |d}~ww )z:
Returns a guestinfo value for the specified key.
z"Getting guestinfo value for key %sz info-get r z(Failed to get guestinfo value for key %sz,Failed to get guestinfo value for key %s: %sNzCUnexpected error while trying to get guestinfo value for key %s: %s) rR rS rm NOVALr r r r r r r )r r5 r6 r r r r' r' r( r sB
r c
C s |dkrd}t d| | z||dt| |f W dS ty7 } ztt d| || W Y d}~dS d}~w tyH tt d| | Y dS w ) z|
Sets a guestinfo value for the specified key. Set value to an empty string
to clear an existing guestinfo key.
r r z$Setting guestinfo key=%s to value=%szinfo-set %s %sTz.Failed to set guestinfo key=%s to value=%s: %sNzAUnexpected error while trying to set guestinfo key=%s to value=%s)rR rS rm r r r r )r valuer5 r6 r r' r' r( r F s6
r c C s | sdS t | ttfvr| g} | D ].}t|}td| t|t||s*td| td| t|d d||s?td| qdS )z
guestinfo_redact_keys redacts guestinfo of all of the keys in the given
list. each key will have its value set to "---". Since the value is valid
YAML, cloud-init can still read it if it tries.
Nz clearing %szfailed to clear %szclearing %s.encodingr r zfailed to clear %s.encoding) typelisttuplerm rR rT r r r )keysr5 r6 r r r' r' r( r q s r c C sF | si S t | tr | S zt| W S tjtfy" t| Y S w )z
load first attempts to unmarshal the provided data as JSON, and if
that fails then attempts to unmarshal the data as YAML. If data is
None then a new dictionary is returned.
)
isinstancedictr load_jsonjsonJSONDecodeError TypeError load_yaml)r r' r' r( rW s
rW c C s | si S d}d| v r| d }| d= d}d| v r | d }| d= |rPt |tjjr4td dt|i}ntd| td||}dt |i}td| || d< | S ) z_
process_metadata processes metadata and loads the optional network
configuration.
Nrt znetwork.encodingz#network data copied to 'config' keyru z network data to be decoded %szmetadata.networkznetwork data %s)
r collectionsabcMappingrR rS ry rz r rW )r rt network_encdec_netr' r' r( rV s*
rV c C s t | tS )zK
Return a list of data sources that match this set of dependencies
)r list_from_depends datasources)dependsr' r' r( get_datasource_list s r c
C s d} d}t }|d D ]}|d dkr|d } nq |d D ]}|d dkr-|d } nq d}d}t }| |v r`|| d }t|dkrNtd | | nt|dkr`d
|d v r`|d d
}||v r|| d }t|dkrxtd || nt|dkrd
|d v r|d d
}|dur|du r|D ]'}|| d D ] } | d
|krt|| d dkr|| d d d
} nqq|du r|dur|D ]'}|| d D ] } | d
|krt|| d dkr|| d d d
} nqq||fS )
aI
Returns the default IPv4 and IPv6 addresses based on the device(s) used for
the default route. Please note that None may be returned for either address
family if that family has no default route or if there are multiple
addresses associated with the device used by the default route for a given
address.
Nr destination0.0.0.0ifacer z::/0 z,device %s has more than one ipv4 address: %sipr z,device %s has more than one ipv6 address: %s)r
route_info netdev_infolenrR rS )
ipv4_ifipv6_ifroutesrouter r netdevaddrsdev_nameaddrr' r' r( get_default_ip_addrs s^
r% r c C st | } | r
| dkrt } zt| ddtjdtj}W n tjy' Y | S w |D ]
}|d r7|d } | S q*| S )zoGet fully qualified domain name from name.
An empty argument is interpreted as meaning the local host.
r Nr r )r r get_hostnamesocket getaddrinfo
SOCK_DGRAM AI_CANONNAMEr )namer" r$ r' r' r( getfqdn
s$ r, c C s& t tj| }|o|jp|jp|j S )zn
Returns false if the address is loopback, link local or unspecified;
otherwise true is returned.
)r maybe_get_address ipaddress
ip_address
is_link_local is_loopbackis_unspecified)r r$ r' r' r( is_valid_ip_addr! s r3 r$ rD c C s, | dsi S | d| d| ddS )a
Takes a cloudinit.netinfo formatted address and converts to netifaces
format, since this module was originally written with netifaces as the
network introspection module.
netifaces ipv4 format:
{
"broadcast": "10.15.255.255",
"netmask": "255.240.0.0",
"addr": "10.0.1.4"
}
cloudinit.netinfo ipv4 format:
{
"ip": "10.0.1.4",
"mask": "255.240.0.0",
"bcast": "10.15.255.255",
"scope": "global",
}
r bcastmask) broadcastnetmaskr$ )r| )r$ r' r' r( convert_to_netifaces_ipv4_format, s
r8 c C s> | dsi S t| d}|j d|jj t|jdS )a
Takes a cloudinit.netinfo formatted address and converts to netifaces
format, since this module was originally written with netifaces as the
network introspection module.
netifaces ipv6 format:
{
"netmask": "ffff:ffff:ffff:ffff::/64",
"addr": "2001:db8:abcd:1234::1"
}
cloudinit.netinfo ipv6 format:
{
"ip": "2001:db8:abcd:1234::1/64",
"scope6": "global",
}
r /)r7 r$ )r| r.
IPv6Interfacer7 rt prefixlenr r )r$ r r' r' r( convert_to_netifaces_ipv6_formatH s
r< c C s ddt t t dii} tt }|r$|| d< || d< || d< t \}}|r/|| t< |r5|| t< | d d d }| d d d }| d d d }t }|D ]}g } g }
|| d
D ] } |
t | q_|| d D ] } |
t | qo||
d } | d
krqS| r| s|
r| }
i }| rg }| D ]}t|d sq|
| q||d
< |
rg }|
D ]}t|d sq|
| q||d < |||
< | r| D ] }|d }
t|
sqt|}|d= | r| |d< |||
< q|
r |
D ] }|d }
t|
sqt|}|d= | r| |d< |||
< qqS| S )zP
Returns host information such as the host name and network interfaces.
rt
interfaces)by-macby-ipv4by-ipv6hostnamezlocal-hostnamelocal_hostnamer> r? r@ r r hwaddrz00:00:00:00:00:00r$ mac)r OrderedDictr, r r& r% r r r r r r8 r< r| r3 ry rz )rh rA default_ipv4 default_ipv6by_macby_ipv4by_ipv6ifacesr# af_inet4af_inet6r$ rD r r
af_inet4_valsip_info
af_inet6_valsr' r' r(
get_host_infoa s
rQ c
C s6 d}d}t | v r6| t }t|v r!|t }t|tr |}nt|}t|v r6|t }t|tr1|}nt|}d\}}}|d u rt }|dpHi } | dpOi }
|
dpVi } |
dp]i } |rn| rht | dknd}|snd }|r~| rxt | dknd}|s~d }|d u rt
d|||| t
d |d u s?t
d
|S ) NF)NFFrt r= r? r@ r z s
Z ?
,+
$
B X8