{"id":13617688,"url":"https://github.com/Azure/WALinuxAgent","last_synced_at":"2025-04-14T06:35:02.200Z","repository":{"id":3518283,"uuid":"4576639","full_name":"Azure/WALinuxAgent","owner":"Azure","description":"Microsoft Azure Linux Guest Agent ","archived":false,"fork":false,"pushed_at":"2024-10-31T16:47:48.000Z","size":43935,"stargazers_count":541,"open_issues_count":114,"forks_count":372,"subscribers_count":89,"default_branch":"master","last_synced_at":"2024-11-05T05:02:17.699Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"http://azure.microsoft.com/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Azure.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":".github/CONTRIBUTING.md","funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":"CODEOWNERS","security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2012-06-06T18:55:55.000Z","updated_at":"2024-10-27T02:02:11.000Z","dependencies_parsed_at":"2023-02-19T11:46:00.735Z","dependency_job_id":"94581007-1f84-437c-b591-4bc00600d2ae","html_url":"https://github.com/Azure/WALinuxAgent","commit_stats":{"total_commits":1961,"total_committers":135,"mean_commits":"14.525925925925925","dds":0.8368179500254972,"last_synced_commit":"dce0341ce81ec6e93bb7b7e59ce5bff6cf58a27d"},"previous_names":[],"tags_count":111,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Azure%2FWALinuxAgent","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Azure%2FWALinuxAgent/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Azure%2FWALinuxAgent/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Azure%2FWALinuxAgent/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Azure","download_url":"https://codeload.github.com/Azure/WALinuxAgent/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":223621963,"owners_count":17174791,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-01T20:01:46.183Z","updated_at":"2025-04-14T06:35:02.181Z","avatar_url":"https://github.com/Azure.png","language":"Python","funding_links":[],"categories":["Python"],"sub_categories":[],"readme":"\n# Microsoft Azure Linux Agent\n\n## Linux distributions support\n\nOur daily automation tests most of the [Linux distributions supported by Azure](https://docs.microsoft.com/en-us/azure/virtual-machines/linux/endorsed-distros); the Agent can be\nused on other distributions as well, but development, testing and support for those are done by the open source community.\n\nTesting is done using the develop branch, which can be unstable. For a stable build please use the master branch instead.\n\n[![CodeCov](https://codecov.io/gh/Azure/WALinuxAgent/branch/develop/graph/badge.svg)](https://codecov.io/gh/Azure/WALinuxAgent/branch/develop)\n\n\n## Introduction\n\nThe Microsoft Azure Linux Agent (waagent) manages Linux provisioning and VM interaction with the Azure Fabric Controller. It provides the following\nfunctionality for Linux IaaS deployments:\n\n* Image Provisioning\n  * Creation of a user account\n  * Configuring SSH authentication types\n  * Deployment of SSH public keys and key pairs\n  * Setting the host name\n  * Publishing the host name to the platform DNS\n  * Reporting SSH host key fingerprint to the platform\n  * Resource Disk Management\n  * Formatting and mounting the resource disk\n  * Configuring swap space\n\n* Networking\n  * Manages routes to improve compatibility with platform DHCP servers\n  * Ensures the stability of the network interface name\n\n* Kernel\n  * Configure virtual NUMA (disable for kernel \u003c2.6.37)\n  * Configure SCSI timeouts for the root device (which could be remote)\n\n* Diagnostics\n  * Console redirection to the serial port\n\n* SCVMM Deployments\n  * Detect and bootstrap the VMM agent for Linux when running in a System\n    Center Virtual Machine Manager 2012R2 environment\n\n* VM Extension\n  * Inject component authored by Microsoft and Partners into Linux VM (IaaS)\n    to enable software and configuration automation\n  * VM Extension reference implementation on [GitHub](https://github.com/Azure/azure-linux-extensions)\n\n## Communication\n\nThe information flow from the platform to the agent occurs via two channels:\n\n* A boot-time attached DVD for IaaS deployments.\n  This DVD includes an OVF-compliant configuration file that includes all\n  provisioning information other than the actual SSH keypairs.\n\n* A TCP endpoint exposing a REST API used to obtain deployment and topology\n  configuration.\n\n### HTTP Proxy\nThe Agent will use an HTTP proxy if provided via the `http_proxy` (for `http` requests) or\n`https_proxy` (for `https` requests) environment variables. Due to limitations of Python, \nthe agent *does not* support HTTP proxies requiring authentication. \n\nSimilarly, the Agent will bypass the proxy if the environment variable `no_proxy` is set.\n\nNote that the way to define those environment variables for the Agent service varies across different distros. For distros\nthat use systemd, a common approach is to use Environment or EnvironmentFile in the [Service] section of the service \ndefinition, for example using an override or a drop-in file (see \"systemctl edit\" for overrides).\n\nExample\n```bash\n    # cat /etc/systemd/system/walinuxagent.service.d/http-proxy.conf\n    [Service]\n    Environment=\"http_proxy=http://proxy.example.com:80/\"\n    Environment=\"https_proxy=http://proxy.example.com:80/\"\n    #\n```\n\nThe Agent passes its environment to the VM Extensions it executes, including `http_proxy` and `https_proxy`, so defining\na proxy for the Agent will also define it for the VM Extensions.\n\n\nThe [`HttpProxy.Host` and `HttpProxy.Port`](#httpproxyhost-httpproxyport) configuration variables, if used, override \nthe environment settings. Note that this configuration variables are local to the Agent process and are not passed to\nVM Extensions.\n\n## Requirements\n\nThe following systems have been tested and are known to work with the Azure\nLinux Agent.  Please note that this list may differ from the official list\nof supported systems on the Microsoft Azure Platform as described [here](https://docs.microsoft.com/en-us/azure/virtual-machines/linux/endorsed-distros).\n\nWaagent depends on some system packages in order to function properly:\n\n* Python 2.6+\n* OpenSSL 1.0+\n* OpenSSH 5.3+\n* Filesystem utilities: sfdisk, fdisk, mkfs, parted\n* Password tools: chpasswd, sudo\n* Text processing tools: sed, grep\n* Network tools: ip-route, iptables\n\n## Installation\n\nInstalling via your distribution's package repository is the only method that is supported.\n\nYou can install from source for more advanced options, such as installing to a custom location or creating \ncustom images. Installing from source, though, may override customizations done to the Agent by your \ndistribution, and is meant only for advanced users. We provide very limited support for this method.\n\nTo install from source, you can use **setuptools**:\n\n```bash\n    sudo python setup.py install --register-service\n```\n\nFor Python 3, use:\n\n```bash\n    sudo python3 setup.py install --register-service\n```\n\nYou can view more installation options by running:\n\n```bash\n    sudo python setup.py install --help\n```\n\nThe agent's log file is kept at `/var/log/waagent.log`.\n\nLastly, you can also customize your own RPM or DEB packages using the configuration\nsamples provided in the deb and rpm sections below. This method is also meant for advanced users and we\nprovide very limited support for it.\n\n\n## Upgrade\n\nUpgrading via your distribution's package repository or using automatic updates are the only supported\nmethods. More information can be found here: [Update Linux Agent](https://learn.microsoft.com/en-us/azure/virtual-machines/extensions/update-linux-agent) \n\nTo upgrade the Agent from source, you can use **setuptools**. Upgrading from source is meant for advanced \nusers and we provide very limited support for it.\n\n```bash\n    sudo python setup.py install --force\n```\n\nRestart waagent service,for most of linux distributions:\n\n```bash\n    sudo service waagent restart\n```\n\nFor Ubuntu, use:\n\n```bash\n    sudo service walinuxagent restart\n```\n\nFor CoreOS, use:\n\n```bash\n    sudo systemctl restart waagent\n```\n\n## Command line options\n\n### Flags\n\n`-verbose`: Increase verbosity of specified command\n\n`-force`: Skip interactive confirmation for some commands\n\n### Commands\n\n`-help`: Lists the supported commands and flags.\n\n`-deprovision`: Attempt to clean the system and make it suitable for re-provisioning, by deleting the following:\n\n* All SSH host keys (if Provisioning.RegenerateSshHostKeyPair is 'y' in the configuration file)\n* Nameserver configuration in /etc/resolv.conf\n* Root password from /etc/shadow (if Provisioning.DeleteRootPassword is 'y' in the configuration file)\n* Cached DHCP client leases\n* Resets host name to localhost.localdomain\n\n  **WARNING!** Deprovision does not guarantee that the image is cleared of all sensitive information and suitable for redistribution.\n\n`-deprovision+user`: Performs everything under deprovision (above) and also deletes the last provisioned user account and associated data.\n\n`-version`: Displays the version of waagent\n\n`-serialconsole`: Configures GRUB to mark ttyS0 (the first serial port) as the boot console. This ensures that kernel bootup logs are sent to the serial port and made available for debugging.\n\n`-daemon`: Run waagent as a daemon to manage interaction with the platform. This argument is specified to waagent in the waagent init script.\n\n`-start`: Run waagent as a background process\n\n`-collect-logs [-full]`: Runs the log collector utility that collects relevant agent logs for debugging and stores them in the agent folder on disk. Exact location will be shown when run. Use flag `-full` for more exhaustive log collection. \n\n## Configuration\n\nA configuration file (/etc/waagent.conf) controls the actions of waagent. Blank lines and lines whose first character is a `#` are ignored (end-of-line comments are *not* supported).\n\nA sample configuration file is shown below:\n\n```yml\nExtensions.Enabled=y\nExtensions.GoalStatePeriod=6\nProvisioning.Agent=auto\nProvisioning.DeleteRootPassword=n\nProvisioning.RegenerateSshHostKeyPair=y\nProvisioning.SshHostKeyPairType=rsa\nProvisioning.MonitorHostName=y\nProvisioning.DecodeCustomData=n\nProvisioning.ExecuteCustomData=n\nProvisioning.PasswordCryptId=6\nProvisioning.PasswordCryptSaltLength=10\nResourceDisk.Format=y\nResourceDisk.Filesystem=ext4\nResourceDisk.MountPoint=/mnt/resource\nResourceDisk.MountOptions=None\nResourceDisk.EnableSwap=n\nResourceDisk.EnableSwapEncryption=n\nResourceDisk.SwapSizeMB=0\nLogs.Verbose=n\nLogs.Collect=y\nLogs.CollectPeriod=3600\nOS.AllowHTTP=n\nOS.RootDeviceScsiTimeout=300\nOS.EnableFIPS=n\nOS.OpensslPath=None\nOS.SshClientAliveInterval=180\nOS.SshDir=/etc/ssh\nHttpProxy.Host=None\nHttpProxy.Port=None\n```\n\nThe various configuration options are described in detail below. Configuration\noptions are of three types : Boolean, String or Integer. The Boolean\nconfiguration options can be specified as \"y\" or \"n\". The special keyword \"None\"\nmay be used for some string type configuration entries as detailed below.\n\n### Configuration File Options\n\n#### __Extensions.Enabled__\n\n_Type: Boolean_  \n_Default: y_\n\nThis allows the user to enable or disable the extension handling functionality in the\nagent. Valid values are \"y\" or \"n\". If extension handling is disabled, the goal state \nwill still be processed and VM status is still reported, but only every 5 minutes. \nExtension config within the goal state will be ignored. Note that functionality such\nas password reset, ssh key updates and backups depend on extensions. Only disable this\nif you do not need extensions at all.\n\n_Note_: disabling extensions in this manner is not the same as running completely \nwithout the agent. In order to do that, the `provisionVMAgent` flag must be set at\nprovisioning time, via whichever API is being used. We will provide more details on\nthis on our wiki when it is generally available. \n\n#### __Extensions.WaitForCloudInit__\n\n_Type: Boolean_  \n_Default: n_\n\nWaits for cloud-init to complete (cloud-init status --wait) before executing VM extensions.\n\nBoth cloud-init and VM extensions are common ways to customize a VM during initial deployment. By\ndefault, the agent will start executing extensions while cloud-init may still be in the 'config' \nstage and won't wait for the 'final' stage to complete. Cloud-init and extensions may execute operations\nthat conflict with each other (for example, both of them may try to install packages). Setting this option\nto 'y' ensures that VM extensions are executed only after cloud-init has completed all its stages.\n\nNote that using this option requires creating a custom image with the value of this option set to 'y', in\norder to ensure that the wait is performed during the initial deployment of the VM.\n\n#### __Extensions.WaitForCloudInitTimeout__\n\n_Type: Integer_  \n_Default: 3600_\n\nTimeout in seconds for the Agent to wait on cloud-init. If the timeout elapses, the Agent will continue \nexecuting VM extensions. See Extensions.WaitForCloudInit for more details. \n\n#### __Extensions.GoalStatePeriod__\n\n_Type: Integer_  \n_Default: 6_\n\nHow often to poll for new goal states (in seconds) and report the status of the VM\nand extensions. Goal states describe the desired state of the extensions on the VM.\n\n_Note_: setting up this parameter to more than a few minutes can make the state of\nthe VM be reported as unresponsive/unavailable on the Azure portal. Also, this \nsetting affects how fast the agent starts executing extensions. \n\n#### __AutoUpdate.UpdateToLatestVersion__\n\n_Type: Boolean_\n_Default: y_\n\nEnables auto-update of the Extension Handler. The Extension Handler is responsible\nfor managing extensions and reporting VM status. The core functionality of the agent\nis contained in the Extension Handler, and we encourage users to enable this option\nin order to maintain an up to date version.\n \nWhen this option is enabled, the Agent will install new versions when they become\navailable. When disabled, the Agent will not install any new versions, but it will use\nthe most recent version already installed on the VM.\n\n_Notes_:\n1. This option was added on version 2.10.0.8 of the Agent. For previous versions, see AutoUpdate.Enabled.\n2. If both options are specified in waagent.conf, AutoUpdate.UpdateToLatestVersion overrides the value set for AutoUpdate.Enabled.\n3. Changing config option requires a service restart to pick up the updated setting.\n\nFor more information on the agent version, see our [FAQ](https://github.com/Azure/WALinuxAgent/wiki/FAQ#what-does-goal-state-agent-mean-in-waagent---version-output). \u003cbr/\u003e\nFor more information on the agent update, see our [FAQ](https://github.com/Azure/WALinuxAgent/wiki/FAQ#how-auto-update-works-for-extension-handler). \u003cbr/\u003e\nFor more information on the AutoUpdate.UpdateToLatestVersion vs AutoUpdate.Enabled, see our [FAQ](https://github.com/Azure/WALinuxAgent/wiki/FAQ#autoupdateenabled-vs-autoupdateupdatetolatestversion). \u003cbr/\u003e\n\n#### __AutoUpdate.Enabled__\n\n_Type: Boolean_  \n_Default: y_\n\nEnables auto-update of the Extension Handler. This flag is supported for legacy reasons and we strongly recommend using AutoUpdate.UpdateToLatestVersion instead. \nThe difference between these 2 flags is that, when set to 'n', AutoUpdate.Enabled will use the version of the Extension Handler that is pre-installed on the image, while AutoUpdate.UpdateToLatestVersion will use the most recent version that has already been installed on the VM (via auto-update).\n\nOn most distros the default value is 'y'.\n\n#### __Provisioning.Agent__\n\n_Type: String_\n_Default: auto_\n\nChoose which provisioning agent to use (or allow waagent to figure it out by\nspecifying \"auto\"). Possible options are \"auto\" (default), \"waagent\", \"cloud-init\",\nor \"disabled\".\n\n#### __Provisioning.Enabled__ (*removed in 2.2.45*)\n\n_Type: Boolean_ \n_Default: y_\n\nThis allows the user to enable or disable the provisioning functionality in the\nagent. Valid values are \"y\" or \"n\". If provisioning is disabled, SSH host and\nuser keys in the image are preserved and any configuration specified in the\nAzure provisioning API is ignored.\n\n_Note_: This configuration option has been removed and has no effect. waagent\nnow auto-detects cloud-init as a provisioning agent (with an option to override\nwith `Provisioning.Agent`).\n\n#### __Provisioning.MonitorHostName__\n\n_Type: Boolean_ \n_Default: n_\n\nMonitor host name changes and publish changes via DHCP requests.\n\n#### __Provisioning.MonitorHostNamePeriod__\n\n_Type: Integer_ \n_Default: 30_\n\nHow often to monitor host name changes (in seconds). This setting is ignored if\nMonitorHostName is not set.\n\n#### __Provisioning.UseCloudInit__\n\n_Type: Boolean_ \n_Default: n_\n\nThis options enables / disables support for provisioning by means of cloud-init.\nWhen true (\"y\"), the agent will wait for cloud-init to complete before installing\nextensions and processing the latest goal state. _Provisioning.Enabled_ must be\ndisabled (\"n\") for this option to have an effect. Setting _Provisioning.Enabled_ to\ntrue (\"y\") overrides this option and runs the built-in agent provisioning code.\n\n_Note_: This configuration option has been removed and has no effect. waagent\nnow auto-detects cloud-init as a provisioning agent (with an option to override\nwith `Provisioning.Agent`).\n\n#### __Provisioning.DeleteRootPassword__  \n\n_Type: Boolean_  \n_Default: n_  \n\nIf set, the root password in the /etc/shadow file is erased during the\nprovisioning process.\n\n#### __Provisioning.RegenerateSshHostKeyPair__\n\n_Type: Boolean_  \n_Default: y_\n\nIf set, all SSH host key pairs (ecdsa, dsa and rsa) are deleted during the\nprovisioning process from /etc/ssh/. And a single fresh key pair is generated.\nThe encryption type for the fresh key pair is configurable by the\nProvisioning.SshHostKeyPairType entry. Please note that some distributions will\nre-create SSH key pairs for any missing encryption types when the SSH daemon is\nrestarted (for example, upon a reboot).\n\n#### __Provisioning.SshHostKeyPairType__\n\n_Type: String_  \n_Default: rsa_\n\nThis can be set to an encryption algorithm type that is supported by the SSH\ndaemon on the VM. The typically supported values are \"rsa\", \"dsa\" and \"ecdsa\".\nNote that \"putty.exe\" on Windows does not support \"ecdsa\". So, if you intend to\nuse putty.exe on Windows to connect to a Linux deployment, please use \"rsa\" or\n\"dsa\".\n\n#### __Provisioning.MonitorHostName__\n\n_Type: Boolean_  \n_Default: y_\n\nIf set, waagent will monitor the Linux VM for hostname changes (as returned by\nthe \"hostname\" command) and automatically update the networking configuration in\nthe image to reflect the change. In order to push the name change to the DNS\nservers, networking will be restarted in the VM. This will result in brief loss\nof Internet connectivity.\n\n#### __Provisioning.DecodeCustomData__\n\n_Type: Boolean_  \n_Default: n_\n\nIf set, waagent will decode CustomData from Base64.\n\n#### __Provisioning.ExecuteCustomData__\n\n_Type: Boolean_  \n_Default: n_\n\nIf set, waagent will execute CustomData after provisioning.\n\n#### __Provisioning.PasswordCryptId__\n\n_Type: String_  \n_Default: 6_\n\nAlgorithm used by crypt when generating password hash.  \n\n* 1 - MD5\n* 2a - Blowfish\n* 5 - SHA-256\n* 6 - SHA-512\n\n#### __Provisioning.PasswordCryptSaltLength__\n\n_Type: String_  \n_Default: 10_\n\nLength of random salt used when generating password hash.\n\n#### __ResourceDisk.Format__\n\n_Type: Boolean_  \n_Default: y_\n\nIf set, the resource disk provided by the platform will be formatted and mounted by waagent if the filesystem type requested by the user in \"ResourceDisk.Filesystem\" is anything other than \"ntfs\". A single partition of\ntype Linux (83) will be made available on the disk. Note that this partition will not be formatted if it can be successfully mounted.\n\n#### __ResourceDisk.Filesystem__\n\n_Type: String_  \n_Default: ext4_\n\nThis specifies the filesystem type for the resource disk. Supported values vary\nby Linux distribution. If the string is X, then mkfs.X should be present on the\nLinux image. SLES 11 images should typically use 'ext3'. BSD images should use\n'ufs2' here.\n\n#### __ResourceDisk.MountPoint__\n\n_Type: String_  \n_Default: /mnt/resource_\n\nThis specifies the path at which the resource disk is mounted.\n\n#### __ResourceDisk.MountOptions__\n\n_Type: String_  \n_Default: None_\n\nSpecifies disk mount options to be passed to the mount -o command. This is a comma\nseparated list of values, ex. 'nodev,nosuid'. See mount(8) for details.\n\n#### __ResourceDisk.EnableSwap__\n\n_Type: Boolean_  \n_Default: n_\n\nIf set, a swap file (/swapfile) is created on the resource disk and added to the\nsystem swap space.\n\n#### __ResourceDisk.EnableSwapEncryption__\n\n_Type: Boolean_  \n_Default: n_\n\nIf set, the swap file (/swapfile) is mounted as an encrypted filesystem (flag supported only on FreeBSD.)\n\n#### __ResourceDisk.SwapSizeMB__\n\n_Type: Integer_  \n_Default: 0_\n\nThe size of the swap file in megabytes.\n\n#### __Logs.Verbose__\n\n_Type: Boolean_  \n_Default: n_\n\nIf set, log verbosity is boosted. Waagent logs to /var/log/waagent.log and\nleverages the system logrotate functionality to rotate logs.\n\n\n#### __Logs.Collect__\n\n_Type: Boolean_  \n_Default: y_\n\nIf set, agent logs will be periodically collected and uploaded to a secure location for improved supportability.\n\nNOTE: This feature relies on the agent's resource usage features (cgroups); this flag will not take effect on any distro not supported.\n\n#### __Logs.CollectPeriod__\n\n_Type: Integer_  \n_Default: 3600_\n\nThis configures how frequently to collect and upload logs. Default is each hour.\n\nNOTE: This only takes effect if the Logs.Collect option is enabled.\n\n#### __OS.AllowHTTP__\n\n_Type: Boolean_  \n_Default: n_\n\nIf SSL support is not compiled into Python, the agent will fail all HTTPS requests.\nYou can set this option to 'y' to make the agent fall-back to HTTP, instead of failing the requests.\n\nNOTE: Allowing HTTP may unintentionally expose secure data.\n\n#### __OS.EnableRDMA__\n\n_Type: Boolean_  \n_Default: n_\n\nIf set, the agent will attempt to install and then load an RDMA kernel driver\nthat matches the version of the firmware on the underlying hardware.\n\n#### __OS.EnableFIPS__\n\n_Type: Boolean_  \n_Default: n_\n\nIf set, the agent will emit into the environment \"OPENSSL_FIPS=1\" when executing\nOpenSSL commands. This signals OpenSSL to use any installed FIPS-compliant libraries.\nNote that the agent itself has no FIPS-specific code. _If no FIPS-compliant certificates are\ninstalled, then enabling this option will cause all OpenSSL commands to fail._\n\n#### __OS.EnableFirewall__\n\n_Type: Boolean_  \n_Default: n (set to 'y' in waagent.conf)_\n\nCreates firewall rules to allow communication with the VM Host only by the Agent.  \n\n#### __OS.MonitorDhcpClientRestartPeriod__\n\n_Type: Integer_\n_Default: 30_\n\nThe agent monitor restarts of the DHCP client and restores network rules when it happens. This\nsetting determines how often (in seconds) to monitor for restarts.\n\n#### __OS.RootDeviceScsiTimeout__\n\n_Type: Integer_  \n_Default: 300_\n\nThis configures the SCSI timeout in seconds on the root device. If not set, the\nsystem defaults are used.\n\n#### __OS.RootDeviceScsiTimeoutPeriod__\n\n_Type: Integer_  \n_Default: 30_\n\nHow often to set the SCSI timeout on the root device (in seconds). This setting is\nignored if RootDeviceScsiTimeout is not set.\n\n#### __OS.OpensslPath__\n\n_Type: String_  \n_Default: None_\n\nThis can be used to specify an alternate path for the openssl binary to use for\ncryptographic operations.\n\n#### __OS.RemovePersistentNetRulesPeriod__\n_Type: Integer_  \n_Default: 30_\n\nHow often to remove the udev rules for persistent network interface names (75-persistent-net-generator.rules\nand /etc/udev/rules.d/70-persistent-net.rules) (in seconds) \n\n#### __OS.SshClientAliveInterval__\n\n_Type: Integer_  \n_Default: 180_\n\nThis values sets the number of seconds the agent uses for the SSH ClientAliveInterval configuration option.\n\n#### __OS.SshDir__\n\n_Type: String_  \n_Default: `/etc/ssh`_\n\nThis option can be used to override the normal location of the SSH configuration\ndirectory.\n\n#### __HttpProxy.Host, HttpProxy.Port__\n\n_Type: String_  \n_Default: None_\n\nIf set, the agent will use this proxy server for HTTP/HTTPS requests. These values\n*will* override the `http_proxy` or `https_proxy` environment variables. Lastly,\n`HttpProxy.Host` is required (if to be used) and `HttpProxy.Port` is optional.\n\n#### __CGroups.EnforceLimits__\n\n_Type: Boolean_  \n_Default: y_\n\nIf set, the agent will attempt to set cgroups limits for cpu and memory for the agent process itself\nas well as extension processes. See the wiki for further details on this.\n\n#### __CGroups.Excluded__\n\n_Type: String_  \n_Default: customscript,runcommand_\n\nThe list of extensions which will be excluded from cgroups limits. This should be comma separated. \n\n### Telemetry\n\nWALinuxAgent collects usage data and sends it to Microsoft to help improve our products and services. The data collected is used to track service health and\nassist with Azure support requests. Data collected does not include any personally identifiable information. Read our [privacy statement](http://go.microsoft.com/fwlink/?LinkId=521839)\nto learn more.\n\nWALinuxAgent does not support disabling telemetry at this time. WALinuxAgent must be removed to disable telemetry collection. If you need this feature,\nplease open an issue in GitHub and explain your requirement.\n\n### Appendix\n\nWe do not maintain packaging information in this repo but some samples are shown below as a reference. See the downstream distribution repositories for officially maintained packaging.\n\n#### deb packages\n\nThe official Ubuntu WALinuxAgent package can be found [here](https://launchpad.net/ubuntu/+source/walinuxagent).\n\nRun once:\n\n1. Install required packages\n\n   ```bash\n   sudo apt-get -y install ubuntu-dev-tools pbuilder python-all debhelper\n   ```\n\n2. Create the pbuilder environment\n\n   ```bash\n   sudo pbuilder create --debootstrapopts --variant=buildd\n   ```\n\n3. Obtain `waagent.dsc` from a downstream package repo\n\nTo compile the package, from the top-most directory:\n\n1. Build the source package\n\n   ```bash\n   dpkg-buildpackage -S\n   ```\n\n2. Build the package\n\n   ```bash\n   sudo pbuilder build waagent.dsc\n   ```\n\n3. Fetch the built package, usually from `/var/cache/pbuilder/result`\n\n#### rpm packages\n\nThe instructions below describe how to build an rpm package.\n\n1. Install setuptools\n\n   ```bash\n   curl https://bootstrap.pypa.io/ez_setup.py -o - | python\n   ```\n\n2. The following command will build the binary and source RPMs:\n\n   ```bash\n   python setup.py bdist_rpm\n   ```\n\n-----\n\nThis project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FAzure%2FWALinuxAgent","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FAzure%2FWALinuxAgent","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FAzure%2FWALinuxAgent/lists"}