'VALUE'})`.\n\n `hour` **Ruby Type:** Integer, String | **Default Value:** `*` The hour at which Chef Infra Client is to run (0 - 23) or a cron pattern such as ‘0,12’.\n\n `job_name` **Ruby Type:** String | **Default Value:** `chef-client` The name of the cron job to create.\n\n `log_directory` **Ruby Type:** String | **Default Value:** `/Library/Logs/Chef on macOS and /var/log/chef otherwise` The path of the directory to create the log file in.\n\n `log_file_name` **Ruby Type:** String | **Default Value:** `client.log` The name of the log file to use.\n\n `mailto` **Ruby Type:** String The e-mail address to e-mail any cron task failures to.\n\n `minute` **Ruby Type:** Integer, String | **Default Value:** `0,30` The minute at which Chef Infra Client is to run (0 - 59) or a cron pattern such as ‘0,30’.\n\n `month` **Ruby Type:** Integer, String | **Default Value:** `*` The month in the year on which Chef Infra Client is to run (1 - 12, jan-dec, or *).\n\n `nice` **Ruby Type:** Integer, String The process priority to run the chef-client process at. A value of -20 is the highest priority and 19 is the lowest priority.\n\n New in Chef Infra Client 16.5 \n\n `splay` **Ruby Type:** Integer, String | **Default Value:** `300` A random number of seconds between 0 and X to add to interval so that all chef-client commands don’t execute at the same time.\n\n `user` **Ruby Type:** String | **Default Value:** `root` The name of the user that Chef Infra Client runs as.\n\n `weekday` **Ruby Type:** Integer, String | **Default Value:** `*` The day of the week on which Chef Infra Client is to run (0-7, mon-sun, or *), where Sunday is both 0 and 7.\n\n \n Common Resource Functionality\n-----------------------------\n\n \n\n---\n\n Chef resources include common properties, notifications, and resource guards.\n\n ### Common Properties\n\n The following properties are common to every resource:\n\n `compile_time` **Ruby Type:** true, false | **Default Value:** `false`\n\n Control the phase during which the resource is run on the node. Set to true to run while the resource collection is being built (the `compile phase`). Set to false to run while Chef Infra Client is configuring the node (the `converge phase`).\n\n `ignore_failure` **Ruby Type:** true, false, :quiet | **Default Value:** `false`\n\n Continue running a recipe if a resource fails for any reason. `:quiet` will not display the full stack trace and the recipe will continue to run if a resource fails.\n\n `retries` **Ruby Type:** Integer | **Default Value:** `0`\n\n The number of attempts to catch exceptions and retry the resource.\n\n `retry_delay` **Ruby Type:** Integer | **Default Value:** `2`\n\n The delay in seconds between retry attempts.\n\n `sensitive` **Ruby Type:** true, false | **Default Value:** `false`\n\n Ensure that sensitive resource data is not logged by Chef Infra Client.\n\n ### Notifications\n\n `notifies` **Ruby Type:** Symbol, 'Chef::Resource[String]'\n\n A resource may notify another resource to take action when its state changes. Specify a `'resource[name]'`, the `:action` that resource should take, and then the `:timer` for that action. A resource may notify more than one resource; use a `notifies` statement for each resource to be notified.\n\n If the referenced resource does not exist, an error is raised. In contrast, `subscribes` will not fail if the source resource is not found.\n\n A timer specifies the point during a Chef Infra Client run at which a notification is run. The following timers are available:\n\n `:before` Specifies that the action on a notified resource should be run before processing the resource block in which the notification is located.\n\n `:delayed` Default. Specifies that a notification should be queued up, and then executed at the end of a Chef Infra Client run.\n\n \n`:immediate`, `:immediately`\n Specifies that a notification should be run immediately, per resource notified.\n\n The syntax for `notifies` is:\n\n \n```\nnotifies :action, 'resource[name]', :timer\n\n```\n `subscribes` **Ruby Type:** Symbol, 'Chef::Resource[String]'\n\n A resource may listen to another resource, and then take action if the state of the resource being listened to changes. Specify a `'resource[name]'`, the `:action` to be taken, and then the `:timer` for that action.\n\n Note that `subscribes` does not apply the specified action to the resource that it listens to - for example:\n\n \n```\nfile '/etc/nginx/ssl/example.crt' do\n mode '0600'\n owner 'root'\nend\n\nservice 'nginx' do\n subscribes :reload, 'file[/etc/nginx/ssl/example.crt]', :immediately\nend\n\n```\n\nIn this case the `subscribes` property reloads the `nginx` service whenever its certificate file, located under `/etc/nginx/ssl/example.crt`, is updated. `subscribes` does not make any changes to the certificate file itself, it merely listens for a change to the file, and executes the `:reload` action for its resource (in this example `nginx`) when a change is detected.\n\n If the other resource does not exist, the subscription will not raise an error. Contrast this with the stricter semantics of `notifies`, which will raise an error if the other resource does not exist.\n\n A timer specifies the point during a Chef Infra Client run at which a notification is run. The following timers are available:\n\n `:before` Specifies that the action on a notified resource should be run before processing the resource block in which the notification is located.\n\n `:delayed` Default. Specifies that a notification should be queued up, and then executed at the end of a Chef Infra Client run.\n\n \n`:immediate`, `:immediately`\n Specifies that a notification should be run immediately, per resource notified.\n\n The syntax for `subscribes` is:\n\n \n```\nsubscribes :action, 'resource[name]', :timer\n\n```\n ### Guards\n\n A guard property can be used to evaluate the state of a node during the execution phase of a Chef Infra Client run. Based on the results of this evaluation, a guard property is then used to tell Chef Infra Client if it should continue executing a resource. A guard property accepts either a string value or a Ruby block value:\n\n * A string is executed as a shell command. If the command returns `0`, the guard is applied. If the command returns any other value, then the guard property is not applied. String guards in a **powershell_script** run Windows PowerShell commands and may return `true` in addition to `0`.\n* A block is executed as Ruby code that must return either `true` or `false`. If the block returns `true`, the guard property is applied. If the block returns `false`, the guard property is not applied.\n\n A guard property is useful for ensuring that a resource is idempotent by allowing that resource to test for the desired state as it is being executed, and then if the desired state is present, for Chef Infra Client to do nothing.\n\n **Properties** The following properties can be used to define a guard that is evaluated during the execution phase of a Chef Infra Client run:\n\n `not_if` Prevent a resource from executing when the condition returns `true`.\n\n `only_if` Allow a resource to execute only if the condition returns `true`.\n\n Examples\n--------\n\n \n\n---\n\n The following examples demonstrate various approaches for using the **chef_client_cron** resource in recipes:\n\n **Setup Chef Infra Client to run using the default 30 minute cadence**:\n\n \n```\nchef_client_cron 'Run Chef Infra Client as a cron job'\n\n```\n\n**Run Chef Infra Client twice a day**:\n\n \n```\nchef_client_cron 'Run Chef Infra Client every 12 hours' do\n minute 0\n hour '0,12'\nend\n\n```\n\n**Run Chef Infra Client with extra options passed to the client**:\n\n \n```\nchef_client_cron 'Run an override recipe' do\n daemon_options ['--override-runlist mycorp_base::default']\nend\n\n```\n \n\n © Chef Software, Inc. \nLicensed under the Creative Commons Attribution 3.0 Unported License. \nThe Chef™ Mark and Chef Logo are either registered trademarks/service marks or trademarks/servicemarks of Chef, in the United States and other countries and are used with Chef Inc's permission. \nWe are not affiliated with, endorsed or sponsored by Chef Inc. \n\n for a complete list of allowed time span values.\n\n `description` **Ruby Type:** String | **Default Value:** `Chef Infra Client periodic execution` The description to add to the systemd timer. This will be displayed when running `systemctl status` for the timer.\n\n `environment` **Ruby Type:** Hash | **Default Value:** `{}` A Hash containing additional arbitrary environment variables under which the systemd timer will be run in the form of `({'ENV_VARIABLE' => 'VALUE'})`.\n\n `interval` **Ruby Type:** String | **Default Value:** `30min` The interval to wait between executions. This is expressed as a systemd time span such as `300seconds`, `1hr`, or `1m`. See for a complete list of allowed time span values.\n\n `job_name` **Ruby Type:** String | **Default Value:** `chef-client` The name of the system timer to create.\n\n `run_on_battery` **Ruby Type:** true, false | **Default Value:** `true` Run the timer for Chef Infra Client if the system is on battery.\n\n `splay` **Ruby Type:** String | **Default Value:** `5min` A interval between 0 and X to add to the interval so that all chef-client commands don’t execute at the same time. This is expressed as a systemd time span such as `300seconds`, `1hr`, or `1m`. See for a complete list of allowed time span values.\n\n `user` **Ruby Type:** String | **Default Value:** `root` The name of the user that Chef Infra Client runs as.\n\n \n Common Resource Functionality\n-----------------------------\n\n \n\n---\n\n Chef resources include common properties, notifications, and resource guards.\n\n ### Common Properties\n\n The following properties are common to every resource:\n\n `compile_time` **Ruby Type:** true, false | **Default Value:** `false`\n\n Control the phase during which the resource is run on the node. Set to true to run while the resource collection is being built (the `compile phase`). Set to false to run while Chef Infra Client is configuring the node (the `converge phase`).\n\n `ignore_failure` **Ruby Type:** true, false, :quiet | **Default Value:** `false`\n\n Continue running a recipe if a resource fails for any reason. `:quiet` will not display the full stack trace and the recipe will continue to run if a resource fails.\n\n `retries` **Ruby Type:** Integer | **Default Value:** `0`\n\n The number of attempts to catch exceptions and retry the resource.\n\n `retry_delay` **Ruby Type:** Integer | **Default Value:** `2`\n\n The delay in seconds between retry attempts.\n\n `sensitive` **Ruby Type:** true, false | **Default Value:** `false`\n\n Ensure that sensitive resource data is not logged by Chef Infra Client.\n\n ### Notifications\n\n `notifies` **Ruby Type:** Symbol, 'Chef::Resource[String]'\n\n A resource may notify another resource to take action when its state changes. Specify a `'resource[name]'`, the `:action` that resource should take, and then the `:timer` for that action. A resource may notify more than one resource; use a `notifies` statement for each resource to be notified.\n\n If the referenced resource does not exist, an error is raised. In contrast, `subscribes` will not fail if the source resource is not found.\n\n A timer specifies the point during a Chef Infra Client run at which a notification is run. The following timers are available:\n\n `:before` Specifies that the action on a notified resource should be run before processing the resource block in which the notification is located.\n\n `:delayed` Default. Specifies that a notification should be queued up, and then executed at the end of a Chef Infra Client run.\n\n \n`:immediate`, `:immediately`\n Specifies that a notification should be run immediately, per resource notified.\n\n The syntax for `notifies` is:\n\n \n```\nnotifies :action, 'resource[name]', :timer\n\n```\n `subscribes` **Ruby Type:** Symbol, 'Chef::Resource[String]'\n\n A resource may listen to another resource, and then take action if the state of the resource being listened to changes. Specify a `'resource[name]'`, the `:action` to be taken, and then the `:timer` for that action.\n\n Note that `subscribes` does not apply the specified action to the resource that it listens to - for example:\n\n \n```\nfile '/etc/nginx/ssl/example.crt' do\n mode '0600'\n owner 'root'\nend\n\nservice 'nginx' do\n subscribes :reload, 'file[/etc/nginx/ssl/example.crt]', :immediately\nend\n\n```\n\nIn this case the `subscribes` property reloads the `nginx` service whenever its certificate file, located under `/etc/nginx/ssl/example.crt`, is updated. `subscribes` does not make any changes to the certificate file itself, it merely listens for a change to the file, and executes the `:reload` action for its resource (in this example `nginx`) when a change is detected.\n\n If the other resource does not exist, the subscription will not raise an error. Contrast this with the stricter semantics of `notifies`, which will raise an error if the other resource does not exist.\n\n A timer specifies the point during a Chef Infra Client run at which a notification is run. The following timers are available:\n\n `:before` Specifies that the action on a notified resource should be run before processing the resource block in which the notification is located.\n\n `:delayed` Default. Specifies that a notification should be queued up, and then executed at the end of a Chef Infra Client run.\n\n \n`:immediate`, `:immediately`\n Specifies that a notification should be run immediately, per resource notified.\n\n The syntax for `subscribes` is:\n\n \n```\nsubscribes :action, 'resource[name]', :timer\n\n```\n ### Guards\n\n A guard property can be used to evaluate the state of a node during the execution phase of a Chef Infra Client run. Based on the results of this evaluation, a guard property is then used to tell Chef Infra Client if it should continue executing a resource. A guard property accepts either a string value or a Ruby block value:\n\n * A string is executed as a shell command. If the command returns `0`, the guard is applied. If the command returns any other value, then the guard property is not applied. String guards in a **powershell_script** run Windows PowerShell commands and may return `true` in addition to `0`.\n* A block is executed as Ruby code that must return either `true` or `false`. If the block returns `true`, the guard property is applied. If the block returns `false`, the guard property is not applied.\n\n A guard property is useful for ensuring that a resource is idempotent by allowing that resource to test for the desired state as it is being executed, and then if the desired state is present, for Chef Infra Client to do nothing.\n\n **Properties** The following properties can be used to define a guard that is evaluated during the execution phase of a Chef Infra Client run:\n\n `not_if` Prevent a resource from executing when the condition returns `true`.\n\n `only_if` Allow a resource to execute only if the condition returns `true`.\n\n Examples\n--------\n\n \n\n---\n\n The following examples demonstrate various approaches for using the **chef_client_systemd_timer** resource in recipes:\n\n **Setup Chef Infra Client to run using the default 30 minute cadence**:\n\n \n```\nchef_client_systemd_timer 'Run Chef Infra Client as a systemd timer'\n\n```\n\n**Run Chef Infra Client every 1 hour**:\n\n \n```\nchef_client_systemd_timer 'Run Chef Infra Client every 1 hour' do\n interval '1hr'\nend\n\n```\n\n**Run Chef Infra Client with extra options passed to the client**:\n\n \n```\nchef_client_systemd_timer 'Run an override recipe' do\n daemon_options ['--override-runlist mycorp_base::default']\nend\n\n```\n \n\n © Chef Software, Inc. \nLicensed under the Creative Commons Attribution 3.0 Unported License. \nThe Chef™ Mark and Chef Logo are either registered trademarks/service marks or trademarks/servicemarks of Chef, in the United States and other countries and are used with Chef Inc's permission. \nWe are not affiliated with, endorsed or sponsored by Chef Inc. \n\n 'VALUE'})`.\n\n `interval` **Ruby Type:** Integer, String | **Default Value:** `30` Time in minutes between Chef Infra Client executions.\n\n `log_directory` **Ruby Type:** String | **Default Value:** `/Library/Logs/Chef` The path of the directory to create the log file in.\n\n `log_file_name` **Ruby Type:** String | **Default Value:** `client.log` The name of the log file to use.\n\n `low_priority_io` **Ruby Type:** true, false | **Default Value:** `true` Run the chef-client process with low priority disk IO\n\n `nice` **Ruby Type:** Integer, String The process priority to run the chef-client process at. A value of -20 is the highest priority and 19 is the lowest priority.\n\n `splay` **Ruby Type:** Integer, String | **Default Value:** `300` A random number of seconds between 0 and X to add to interval so that all chef-client commands don’t execute at the same time.\n\n `user` **Ruby Type:** String | **Default Value:** `root` The name of the user that Chef Infra Client runs as.\n\n `working_directory` **Ruby Type:** String | **Default Value:** `/var/root` The working directory to run the Chef Infra Client from.\n\n \n Common Resource Functionality\n-----------------------------\n\n \n\n---\n\n Chef resources include common properties, notifications, and resource guards.\n\n ### Common Properties\n\n The following properties are common to every resource:\n\n `compile_time` **Ruby Type:** true, false | **Default Value:** `false`\n\n Control the phase during which the resource is run on the node. Set to true to run while the resource collection is being built (the `compile phase`). Set to false to run while Chef Infra Client is configuring the node (the `converge phase`).\n\n `ignore_failure` **Ruby Type:** true, false, :quiet | **Default Value:** `false`\n\n Continue running a recipe if a resource fails for any reason. `:quiet` will not display the full stack trace and the recipe will continue to run if a resource fails.\n\n `retries` **Ruby Type:** Integer | **Default Value:** `0`\n\n The number of attempts to catch exceptions and retry the resource.\n\n `retry_delay` **Ruby Type:** Integer | **Default Value:** `2`\n\n The delay in seconds between retry attempts.\n\n `sensitive` **Ruby Type:** true, false | **Default Value:** `false`\n\n Ensure that sensitive resource data is not logged by Chef Infra Client.\n\n ### Notifications\n\n `notifies` **Ruby Type:** Symbol, 'Chef::Resource[String]'\n\n A resource may notify another resource to take action when its state changes. Specify a `'resource[name]'`, the `:action` that resource should take, and then the `:timer` for that action. A resource may notify more than one resource; use a `notifies` statement for each resource to be notified.\n\n If the referenced resource does not exist, an error is raised. In contrast, `subscribes` will not fail if the source resource is not found.\n\n A timer specifies the point during a Chef Infra Client run at which a notification is run. The following timers are available:\n\n `:before` Specifies that the action on a notified resource should be run before processing the resource block in which the notification is located.\n\n `:delayed` Default. Specifies that a notification should be queued up, and then executed at the end of a Chef Infra Client run.\n\n \n`:immediate`, `:immediately`\n Specifies that a notification should be run immediately, per resource notified.\n\n The syntax for `notifies` is:\n\n \n```\nnotifies :action, 'resource[name]', :timer\n\n```\n `subscribes` **Ruby Type:** Symbol, 'Chef::Resource[String]'\n\n A resource may listen to another resource, and then take action if the state of the resource being listened to changes. Specify a `'resource[name]'`, the `:action` to be taken, and then the `:timer` for that action.\n\n Note that `subscribes` does not apply the specified action to the resource that it listens to - for example:\n\n \n```\nfile '/etc/nginx/ssl/example.crt' do\n mode '0600'\n owner 'root'\nend\n\nservice 'nginx' do\n subscribes :reload, 'file[/etc/nginx/ssl/example.crt]', :immediately\nend\n\n```\n\nIn this case the `subscribes` property reloads the `nginx` service whenever its certificate file, located under `/etc/nginx/ssl/example.crt`, is updated. `subscribes` does not make any changes to the certificate file itself, it merely listens for a change to the file, and executes the `:reload` action for its resource (in this example `nginx`) when a change is detected.\n\n If the other resource does not exist, the subscription will not raise an error. Contrast this with the stricter semantics of `notifies`, which will raise an error if the other resource does not exist.\n\n A timer specifies the point during a Chef Infra Client run at which a notification is run. The following timers are available:\n\n `:before` Specifies that the action on a notified resource should be run before processing the resource block in which the notification is located.\n\n `:delayed` Default. Specifies that a notification should be queued up, and then executed at the end of a Chef Infra Client run.\n\n \n`:immediate`, `:immediately`\n Specifies that a notification should be run immediately, per resource notified.\n\n The syntax for `subscribes` is:\n\n \n```\nsubscribes :action, 'resource[name]', :timer\n\n```\n ### Guards\n\n A guard property can be used to evaluate the state of a node during the execution phase of a Chef Infra Client run. Based on the results of this evaluation, a guard property is then used to tell Chef Infra Client if it should continue executing a resource. A guard property accepts either a string value or a Ruby block value:\n\n * A string is executed as a shell command. If the command returns `0`, the guard is applied. If the command returns any other value, then the guard property is not applied. String guards in a **powershell_script** run Windows PowerShell commands and may return `true` in addition to `0`.\n* A block is executed as Ruby code that must return either `true` or `false`. If the block returns `true`, the guard property is applied. If the block returns `false`, the guard property is not applied.\n\n A guard property is useful for ensuring that a resource is idempotent by allowing that resource to test for the desired state as it is being executed, and then if the desired state is present, for Chef Infra Client to do nothing.\n\n **Properties** The following properties can be used to define a guard that is evaluated during the execution phase of a Chef Infra Client run:\n\n `not_if` Prevent a resource from executing when the condition returns `true`.\n\n `only_if` Allow a resource to execute only if the condition returns `true`.\n\n Examples\n--------\n\n \n\n---\n\n The following examples demonstrate various approaches for using the **chef_client_launchd** resource in recipes:\n\n **Set the Chef Infra Client to run on a schedule**:\n\n \n```\nchef_client_launchd 'Setup the Chef Infra Client to run every 30 minutes' do\n interval 30\n action :enable\nend\n\n```\n\n**Disable the Chef Infra Client running on a schedule**:\n\n \n```\nchef_client_launchd 'Prevent the Chef Infra Client from running on a schedule' do\n action :disable\nend\n\n```\n \n\n © Chef Software, Inc. \nLicensed under the Creative Commons Attribution 3.0 Unported License. \nThe Chef™ Mark and Chef Logo are either registered trademarks/service marks or trademarks/servicemarks of Chef, in the United States and other countries and are used with Chef Inc's permission. \nWe are not affiliated with, endorsed or sponsored by Chef Inc. \n\n \"chef\"\n}\n\n```\n `remove_clients` …\n\n `remove_groups` …\n\n `remove_users` …\n\n `subscribes` **Ruby Type:** Symbol, Chef::Resource\\[String\\] \nA resource may listen to another resource, and then take action if the state of the resource being listened to changes. Specify a `'resource[name]'`, the `:action` to be taken, and then the `:timer` for that action.\n\n Note that `subscribes` does not apply the specified action to the resource that it listens to - for example:\n\n \n```\nfile '/etc/nginx/ssl/example.crt' do\n mode '0600'\n owner 'root'\nend\n\nservice 'nginx' do\n subscribes :reload, 'file[/etc/nginx/ssl/example.crt]', :immediately\nend\n\n```\n\nIn this case the `subscribes` property reloads the `nginx` service whenever its certificate file, located under `/etc/nginx/ssl/example.crt`, is updated. `subscribes` does not make any changes to the certificate file itself, it merely listens for a change to the file, and executes the `:reload` action for its resource (in this example `nginx`) when a change is detected.\n\n If the other resource does not exist, the subscription will not raise an error. Contrast this with the stricter semantics of `notifies`, which will raise an error if the other resource does not exist.\n\nA timer specifies the point during a Chef Infra Client run at which a notification is run. The following timers are available:\n\n `:before` Specifies that the action on a notified resource should be run before processing the resource block in which the notification is located.\n\n `:delayed` Default. Specifies that a notification should be queued up, and then executed at the end of a Chef Infra Client run.\n\n \n`:immediate`, `:immediately`\n Specifies that a notification should be run immediately, per resource notified.\n\n \nThe syntax for `subscribes` is:\n\n \n```\nsubscribes :action, 'resource[name]', :timer\n\n```\n `users` …\n\n Examples\n--------\n\n \n\n---\n\n This resource does not have any examples.\n\n \n\n © Chef Software, Inc. \nLicensed under the Creative Commons Attribution 3.0 Unported License. \nThe Chef™ Mark and Chef Logo are either registered trademarks/service marks or trademarks/servicemarks of Chef, in the United States and other countries and are used with Chef Inc's permission. \nWe are not affiliated with, endorsed or sponsored by Chef Inc. \n\n\n \n \n \n \n \n hy\n xPxTuW1CrbV8/q71FdIzSOcicSt/qbLVyt\n ww9HdFxBIuGa+RuT5q0iBikusbpJHAwnnqP7i/dAcg4\n -----END CERTIFICATE-----\n CERT\nend\n\n```\n \n\n © Chef Software, Inc. \nLicensed under the Creative Commons Attribution 3.0 Unported License. \nThe Chef™ Mark and Chef Logo are either registered trademarks/service marks or trademarks/servicemarks of Chef, in the United States and other countries and are used with Chef Inc's permission. \nWe are not affiliated with, endorsed or sponsored by Chef Inc. \n\n\"\n}\n\n```\n `subscribes` **Ruby Type:** Symbol, Chef::Resource\\[String\\] \nA resource may listen to another resource, and then take action if the state of the resource being listened to changes. Specify a `'resource[name]'`, the `:action` to be taken, and then the `:timer` for that action.\n\n Note that `subscribes` does not apply the specified action to the resource that it listens to - for example:\n\n \n```\nfile '/etc/nginx/ssl/example.crt' do\n mode '0600'\n owner 'root'\nend\n\nservice 'nginx' do\n subscribes :reload, 'file[/etc/nginx/ssl/example.crt]', :immediately\nend\n\n```\n\nIn this case the `subscribes` property reloads the `nginx` service whenever its certificate file, located under `/etc/nginx/ssl/example.crt`, is updated. `subscribes` does not make any changes to the certificate file itself, it merely listens for a change to the file, and executes the `:reload` action for its resource (in this example `nginx`) when a change is detected.\n\n If the other resource does not exist, the subscription will not raise an error. Contrast this with the stricter semantics of `notifies`, which will raise an error if the other resource does not exist.\n\nA timer specifies the point during a Chef Infra Client run at which a notification is run. The following timers are available:\n\n `:before` Specifies that the action on a notified resource should be run before processing the resource block in which the notification is located.\n\n `:delayed` Default. Specifies that a notification should be queued up, and then executed at the end of a Chef Infra Client run.\n\n \n`:immediate`, `:immediately`\n Specifies that a notification should be run immediately, per resource notified.\n\n \nThe syntax for `subscribes` is:\n\n \n```\nsubscribes :action, 'resource[name]', :timer\n\n```\n Examples\n--------\n\n \n\n---\n\n This resource does not have any examples.\n\n \n\n © Chef Software, Inc. \nLicensed under the Creative Commons Attribution 3.0 Unported License. \nThe Chef™ Mark and Chef Logo are either registered trademarks/service marks or trademarks/servicemarks of Chef, in the United States and other countries and are used with Chef Inc's permission. \nWe are not affiliated with, endorsed or sponsored by Chef Inc. \n\n '/var/chef/reports'\n action :enable\nend\n\n```\n\nand:\n\n \n```\nchef_handler 'Chef::Handler::ErrorReport' do\n source 'chef/handler/error_report'\n action :enable\nend\n\n```\n\nshow how to enable those handlers in a recipe.\n\n The full syntax for all of the properties that are available to the **chef_handler** resource is:\n\n```\nchef_handler 'name' do\n arguments Array, Hash # default value: []\n class_name String # default value: 'name' unless specified\n source String\n type Hash # default value: {\"report\"=>true, \"exception\"=>true}\n action Symbol # defaults to :enable if not specified\nend\n```\n where:\n\n * `chef_handler` is the resource.\n* `name` is the name given to the resource block.\n* `action` identifies which steps Chef Infra Client will take to bring the node into the desired state.\n* `arguments`, `class_name`, `source`, and `type` are the properties available to this resource.\n\n Actions\n-------\n\n \n\n---\n\n The **chef_handler** resource has the following actions:\n\n `:disable` Disables the handler for the current Chef Infra Client run on the current node. `:enable` Enables the handler for the current Chef Infra Client run on the current node. (default) `:nothing` This resource block does not act unless notified by another resource to take action. Once notified, this resource block either runs immediately or is queued up to run at the end of a Chef Infra Client run. Properties\n----------\n\n \n\n---\n\n The **chef_handler** resource has the following properties:\n\n `arguments` **Ruby Type:** Array, Hash | **Default Value:** `[]`\nAn array of arguments that are passed to the initializer for the handler class. For example:\n\n \n```\narguments :key1 => 'val1'\n\n```\n\nor:\n\n \n```\narguments [:key1 => 'val1', :key2 => 'val2']\n\n```\n `class_name` **Ruby Type:** String | **Default Value:** `The resource block's name` The name of the handler class. This can be module name-spaced.\n\n `source` **Ruby Type:** String The full path to the handler file. Can also be a gem path if the handler ships as part of a Ruby gem.\n\n `type` **Ruby Type:** Hash | **Default Value:** `{\"report\"=>true, \"exception\"=>true}` The type of handler to register as, i.e. :report, :exception or both.\n\n \n Common Resource Functionality\n-----------------------------\n\n \n\n---\n\n Chef resources include common properties, notifications, and resource guards.\n\n ### Common Properties\n\n The following properties are common to every resource:\n\n `compile_time` **Ruby Type:** true, false | **Default Value:** `false`\n\n Control the phase during which the resource is run on the node. Set to true to run while the resource collection is being built (the `compile phase`). Set to false to run while Chef Infra Client is configuring the node (the `converge phase`).\n\n `ignore_failure` **Ruby Type:** true, false, :quiet | **Default Value:** `false`\n\n Continue running a recipe if a resource fails for any reason. `:quiet` will not display the full stack trace and the recipe will continue to run if a resource fails.\n\n `retries` **Ruby Type:** Integer | **Default Value:** `0`\n\n The number of attempts to catch exceptions and retry the resource.\n\n `retry_delay` **Ruby Type:** Integer | **Default Value:** `2`\n\n The delay in seconds between retry attempts.\n\n `sensitive` **Ruby Type:** true, false | **Default Value:** `false`\n\n Ensure that sensitive resource data is not logged by Chef Infra Client.\n\n ### Notifications\n\n `notifies` **Ruby Type:** Symbol, 'Chef::Resource[String]'\n\n A resource may notify another resource to take action when its state changes. Specify a `'resource[name]'`, the `:action` that resource should take, and then the `:timer` for that action. A resource may notify more than one resource; use a `notifies` statement for each resource to be notified.\n\n If the referenced resource does not exist, an error is raised. In contrast, `subscribes` will not fail if the source resource is not found.\n\n A timer specifies the point during a Chef Infra Client run at which a notification is run. The following timers are available:\n\n `:before` Specifies that the action on a notified resource should be run before processing the resource block in which the notification is located.\n\n `:delayed` Default. Specifies that a notification should be queued up, and then executed at the end of a Chef Infra Client run.\n\n \n`:immediate`, `:immediately`\n Specifies that a notification should be run immediately, per resource notified.\n\n The syntax for `notifies` is:\n\n \n```\nnotifies :action, 'resource[name]', :timer\n\n```\n `subscribes` **Ruby Type:** Symbol, 'Chef::Resource[String]'\n\n A resource may listen to another resource, and then take action if the state of the resource being listened to changes. Specify a `'resource[name]'`, the `:action` to be taken, and then the `:timer` for that action.\n\n Note that `subscribes` does not apply the specified action to the resource that it listens to - for example:\n\n \n```\nfile '/etc/nginx/ssl/example.crt' do\n mode '0600'\n owner 'root'\nend\n\nservice 'nginx' do\n subscribes :reload, 'file[/etc/nginx/ssl/example.crt]', :immediately\nend\n\n```\n\nIn this case the `subscribes` property reloads the `nginx` service whenever its certificate file, located under `/etc/nginx/ssl/example.crt`, is updated. `subscribes` does not make any changes to the certificate file itself, it merely listens for a change to the file, and executes the `:reload` action for its resource (in this example `nginx`) when a change is detected.\n\n If the other resource does not exist, the subscription will not raise an error. Contrast this with the stricter semantics of `notifies`, which will raise an error if the other resource does not exist.\n\n A timer specifies the point during a Chef Infra Client run at which a notification is run. The following timers are available:\n\n `:before` Specifies that the action on a notified resource should be run before processing the resource block in which the notification is located.\n\n `:delayed` Default. Specifies that a notification should be queued up, and then executed at the end of a Chef Infra Client run.\n\n \n`:immediate`, `:immediately`\n Specifies that a notification should be run immediately, per resource notified.\n\n The syntax for `subscribes` is:\n\n \n```\nsubscribes :action, 'resource[name]', :timer\n\n```\n ### Guards\n\n A guard property can be used to evaluate the state of a node during the execution phase of a Chef Infra Client run. Based on the results of this evaluation, a guard property is then used to tell Chef Infra Client if it should continue executing a resource. A guard property accepts either a string value or a Ruby block value:\n\n * A string is executed as a shell command. If the command returns `0`, the guard is applied. If the command returns any other value, then the guard property is not applied. String guards in a **powershell_script** run Windows PowerShell commands and may return `true` in addition to `0`.\n* A block is executed as Ruby code that must return either `true` or `false`. If the block returns `true`, the guard property is applied. If the block returns `false`, the guard property is not applied.\n\n A guard property is useful for ensuring that a resource is idempotent by allowing that resource to test for the desired state as it is being executed, and then if the desired state is present, for Chef Infra Client to do nothing.\n\n **Properties** The following properties can be used to define a guard that is evaluated during the execution phase of a Chef Infra Client run:\n\n `not_if` Prevent a resource from executing when the condition returns `true`.\n\n `only_if` Allow a resource to execute only if the condition returns `true`.\n\n Examples\n--------\n\n \n\n---\n\n The following examples demonstrate various approaches for using the **chef_handler** resource in recipes:\n\n **Enable the ‘MyHandler’ handler**\n\n The following example shows how to enable a fictional ‘MyHandler’ handler which is located on disk at `/etc/chef/my_handler.rb`. The handler will be configured to run with Chef Infra Client and will be passed values to the handler’s initializer method:\n\n \n```\nchef_handler 'MyHandler' do\n source '/etc/chef/my_handler.rb' # the file should already be at this path\n arguments path: '/var/chef/reports'\n action :enable\nend\n\n```\n\n**Enable handlers during the compile phase**\n\n \n```\nchef_handler 'Chef::Handler::JsonFile' do\n source 'chef/handler/json_file'\n arguments path: '/var/chef/reports'\n action :enable\n compile_time true\nend\n\n```\n\n**Handle only exceptions**\n\n \n```\nchef_handler 'Chef::Handler::JsonFile' do\n source 'chef/handler/json_file'\n arguments path: '/var/chef/reports'\n type exception: true\n action :enable\nend\n\n```\n\n**Cookbook Versions (a custom handler)**\n\n [@juliandunn](https://github.com/juliandunn) created a custom report handler that logs all of the cookbooks and cookbook versions that were used during a Chef Infra Client run, and then reports after the run is complete.\n\n cookbook_versions.rb:\n\n The following custom handler defines how cookbooks and cookbook versions that are used during a Chef Infra Client run will be compiled into a report using the `Chef::Log` class in Chef Infra Client:\n\n \n```\nrequire 'chef/log'\n\nmodule Chef\n class CookbookVersionsHandler < Chef::Handler\n def report\n cookbooks = run_context.cookbook_collection\n Chef::Log.info('Cookbooks and versions run: #{cookbooks.map {|x| x.name.to_s + ' ' + x.version }}')\n end\n end\nend\n\n```\n\ndefault.rb:\n\n The following recipe is added to the run-list for every node on which a list of cookbooks and versions will be generated as report output after every Chef Infra Client run.\n\n \n```\ncookbook_file '/etc/chef/cookbook_versions.rb' do\n source 'cookbook_versions.rb'\n action :create\nend\n\nchef_handler 'Chef::CookbookVersionsHandler' do\n source '/etc/chef/cookbook_versions.rb'\n type report: true\n action :enable\nend\n\n```\n\nThis recipe will generate report output similar to the following:\n\n \n```\n[2013-11-26T03:11:06+00:00] INFO: Chef Infra Client Run complete in 0.300029878 seconds\n[2013-11-26T03:11:06+00:00] INFO: Running report handlers\n[2013-11-26T03:11:06+00:00] INFO: Cookbooks and versions run: [\"cookbook_versions_handler 1.0.0\"]\n[2013-11-26T03:11:06+00:00] INFO: Report handlers complete\n\n```\n\n**JsonFile Handler**\n\n The JsonFile handler is available from the `chef_handler` cookbook and can be used with exceptions and reports. It serializes run status data to a JSON file. This handler may be enabled in one of the following ways.\n\n By adding the following lines of Ruby code to either the client.rb file or the solo.rb file, depending on how Chef Infra Client is being run:\n\n \n```\nrequire 'chef/handler/json_file'\nreport_handlers << Chef::Handler::JsonFile.new(path: '/var/chef/reports')\nexception_handlers << Chef::Handler::JsonFile.new(path: '/var/chef/reports')\n\n```\n\nBy using the `chef_handler` resource in a recipe, similar to the following:\n\n \n```\nchef_handler 'Chef::Handler::JsonFile' do\n source 'chef/handler/json_file'\n arguments path: '/var/chef/reports'\n action :enable\nend\n\n```\n\nAfter it has run, the run status data can be loaded and inspected via Interactive Ruby (IRb):\n\n \n```\nirb(main):002:0> require 'json' => true\nirb(main):003:0> require 'chef' => true\nirb(main):004:0> r = JSON.parse(IO.read('/var/chef/reports/chef-run-report-20110322060731.json')) => ... output truncated\nirb(main):005:0> r.keys => ['end_time', 'node', 'updated_resources', 'exception', 'all_resources', 'success', 'elapsed_time', 'start_time', 'backtrace']\nirb(main):006:0> r['elapsed_time'] => 0.00246\n\n```\n\nRegister the JsonFile handler\n\n \n```\nchef_handler 'Chef::Handler::JsonFile' do\n source 'chef/handler/json_file'\n arguments path: '/var/chef/reports'\n action :enable\nend\n\n```\n\n**ErrorReport Handler**\n\n The ErrorReport handler is built into Chef Infra Client and can be used for both exceptions and reports. It serializes error report data to a JSON file. This handler may be enabled in one of the following ways.\n\n By adding the following lines of Ruby code to either the client.rb file or the solo.rb file, depending on how Chef Infra Client is being run:\n\n \n```\nrequire 'chef/handler/error_report'\nreport_handlers << Chef::Handler::ErrorReport.new\nexception_handlers << Chef::Handler::ErrorReport.new\n\n```\n\nBy using the `chef_handler` resource in a recipe, similar to the following:\n\n \n```\nchef_handler 'Chef::Handler::ErrorReport' do\n source 'chef/handler/error_report'\n action :enable\nend\n\n```\n \n\n © Chef Software, Inc. \nLicensed under the Creative Commons Attribution 3.0 Unported License. \nThe Chef™ Mark and Chef Logo are either registered trademarks/service marks or trademarks/servicemarks of Chef, in the United States and other countries and are used with Chef Inc's permission. \nWe are not affiliated with, endorsed or sponsored by Chef Inc. \n\n, Inc\",\n \"guid\": \"f980d1asdfda0331235s00ff36862\n ...\n}\n\n```\n `remove_members` Use to remove the specified users from an organization. Invitations that have not been accepted will be cancelled.\n\n `subscribes` **Ruby Type:** Symbol, Chef::Resource\\[String\\] \nA resource may listen to another resource, and then take action if the state of the resource being listened to changes. Specify a `'resource[name]'`, the `:action` to be taken, and then the `:timer` for that action.\n\n Note that `subscribes` does not apply the specified action to the resource that it listens to - for example:\n\n \n```\nfile '/etc/nginx/ssl/example.crt' do\n mode '0600'\n owner 'root'\nend\n\nservice 'nginx' do\n subscribes :reload, 'file[/etc/nginx/ssl/example.crt]', :immediately\nend\n\n```\n\nIn this case the `subscribes` property reloads the `nginx` service whenever its certificate file, located under `/etc/nginx/ssl/example.crt`, is updated. `subscribes` does not make any changes to the certificate file itself, it merely listens for a change to the file, and executes the `:reload` action for its resource (in this example `nginx`) when a change is detected.\n\n If the other resource does not exist, the subscription will not raise an error. Contrast this with the stricter semantics of `notifies`, which will raise an error if the other resource does not exist.\n\nA timer specifies the point during a Chef Infra Client run at which a notification is run. The following timers are available:\n\n `:before` Specifies that the action on a notified resource should be run before processing the resource block in which the notification is located.\n\n `:delayed` Default. Specifies that a notification should be queued up, and then executed at the end of a Chef Infra Client run.\n\n \n`:immediate`, `:immediately`\n Specifies that a notification should be run immediately, per resource notified.\n\n \nThe syntax for `subscribes` is:\n\n \n```\nsubscribes :action, 'resource[name]', :timer\n\n```\n Examples\n--------\n\n \n\n---\n\n This resource does not have any examples.\n\n \n\n © Chef Software, Inc. \nLicensed under the Creative Commons Attribution 3.0 Unported License. \nThe Chef™ Mark and Chef Logo are either registered trademarks/service marks or trademarks/servicemarks of Chef, in the United States and other countries and are used with Chef Inc's permission. \nWe are not affiliated with, endorsed or sponsored by Chef Inc. \n\n\"\n}\n\n```\n `recovery_authentication_enabled` …\n\n `source_key` Use to copy a public or private key, but apply a different `format` and `password`. Use in conjunction with `source_key_pass_phrase` and `source_key_path`.\n\n `source_key_pass_phrase` The pass phrase for the public key. Use in conjunction with `source_key` and `source_key_path`.\n\n `source_key_path` The path to the public key. Use in conjunction with `source_key` and `source_key_pass_phrase`.\n\n `subscribes` **Ruby Type:** Symbol, Chef::Resource\\[String\\] \nA resource may listen to another resource, and then take action if the state of the resource being listened to changes. Specify a `'resource[name]'`, the `:action` to be taken, and then the `:timer` for that action.\n\n Note that `subscribes` does not apply the specified action to the resource that it listens to - for example:\n\n \n```\nfile '/etc/nginx/ssl/example.crt' do\n mode '0600'\n owner 'root'\nend\n\nservice 'nginx' do\n subscribes :reload, 'file[/etc/nginx/ssl/example.crt]', :immediately\nend\n\n```\n\nIn this case the `subscribes` property reloads the `nginx` service whenever its certificate file, located under `/etc/nginx/ssl/example.crt`, is updated. `subscribes` does not make any changes to the certificate file itself, it merely listens for a change to the file, and executes the `:reload` action for its resource (in this example `nginx`) when a change is detected.\n\n If the other resource does not exist, the subscription will not raise an error. Contrast this with the stricter semantics of `notifies`, which will raise an error if the other resource does not exist.\n\nA timer specifies the point during a Chef Infra Client run at which a notification is run. The following timers are available:\n\n `:before` Specifies that the action on a notified resource should be run before processing the resource block in which the notification is located.\n\n `:delayed` Default. Specifies that a notification should be queued up, and then executed at the end of a Chef Infra Client run.\n\n \n`:immediate`, `:immediately`\n Specifies that a notification should be run immediately, per resource notified.\n\n \nThe syntax for `subscribes` is:\n\n \n```\nsubscribes :action, 'resource[name]', :timer\n\n```\n Examples\n--------\n\n \n\n---\n\n This resource does not have any examples.\n\n \n\n © Chef Software, Inc. \nLicensed under the Creative Commons Attribution 3.0 Unported License. \nThe Chef™ Mark and Chef Logo are either registered trademarks/service marks or trademarks/servicemarks of Chef, in the United States and other countries and are used with Chef Inc's permission. \nWe are not affiliated with, endorsed or sponsored by Chef Inc. \n\n 'baz' })\n admins 'jtimberman'\n search '*:*'\nend\n\n```\n\n**To allow multiple admins access to an item**:\n\n \n```\nchef_vault_secret 'root-password' do\n admins 'jtimberman,paulmooring'\n data_bag 'secrets'\n raw_data({ 'auth' => 'DoNotUseThisPasswordForRoot' })\n search '*:*'\nend\n\n```\n \n\n © Chef Software, Inc. \nLicensed under the Creative Commons Attribution 3.0 Unported License. \nThe Chef™ Mark and Chef Logo are either registered trademarks/service marks or trademarks/servicemarks of Chef, in the United States and other countries and are used with Chef Inc's permission. \nWe are not affiliated with, endorsed or sponsored by Chef Inc. \n\n, , ` where `` specifies the rights granted to the principal, `` is the group or user name, and `` is a Hash with one (or more) advanced rights options.\n\n `source` **Ruby Type:** String, Array | **Default Value:** `The resource block's name` The name of the file in `COOKBOOK_NAME/files/default` or the path to a file located in `COOKBOOK_NAME/files`. The path must include the file name and its extension. This can be used to distribute specific files depending upon the platform used - see [File Specificity](#cookbook-file-specificity) for more information.\n\n `verify` **Ruby Type:** String, Block \nA block or a string that returns `true` or `false`. A string, when `true` is executed as a system command.\n\n A block is arbitrary Ruby defined within the resource block by using the `verify` property. When a block is `true`, Chef Infra Client will continue to update the file as appropriate.\n\n For example, this should return `true`:\n\n \n```\ncookbook_file '/tmp/baz' do\n verify { 1 == 1 }\nend\n\n```\n\nThis should return `true`:\n\n \n```\ncookbook_file '/etc/nginx.conf' do\n verify 'nginx -t -c %{path}'\nend\n\n```\n\nThis should return `true`:\n\n \n```\ncookbook_file '/tmp/bar' do\n verify { 1 == 1}\nend\n\n```\n\nAnd this should return `true`:\n\n \n```\ncookbook_file '/tmp/foo' do\n verify do |path|\n true\n end\nend\n\n```\n\nWhereas, this should return `false`:\n\n \n```\ncookbook_file '/tmp/turtle' do\n verify '/usr/bin/false'\nend\n\n```\n\nIf a string or a block return `false`, the Chef Infra Client run will stop and an error is returned.\n\n ### Atomic File Updates\n\n Atomic updates are used with **file**-based resources to help ensure that file updates can be made when updating a binary or if disk space runs out.\n\n Atomic updates are enabled by default. They can be managed globally using the `file_atomic_update` setting in the client.rb file. They can be managed on a per-resource basis using the `atomic_update` property that is available with the **cookbook_file**, **file**, **remote_file**, and **template** resources.\n\n Note\n\n On certain platforms, and after a file has been moved into place, Chef Infra Client may modify file permissions to support features specific to those platforms. On platforms with SELinux enabled, Chef Infra Client will fix up the security contexts after a file has been moved into the correct location by running the `restorecon` command. On the Microsoft Windows platform, Chef Infra Client will create files so that ACL inheritance works as expected.\n\n ### Windows File Security\n\n To support Microsoft Windows security, the **template**, **file**, **remote_file**, **cookbook_file**, **directory**, and **remote_directory** resources support the use of inheritance and access control lists (ACLs) within recipes. **Access Control Lists (ACLs)** The `rights` property can be used in a recipe to manage access control lists (ACLs), which allow permissions to be given to multiple users and groups. Use the `rights` property can be used as many times as necessary; Chef Infra Client will apply them to the file or directory as required. The syntax for the `rights` property is as follows:\n\n \n```\nrights permission, principal, option_type => value\n\n```\n\nwhere\n\n `permission` Use to specify which rights are granted to the `principal`. The possible values are: `:read`, `:write`, `read_execute`, `:modify`, `:full_control`, or an integer.\n\n Integers used for permissions must match the following list [FileSystemRights Enum](https://docs.microsoft.com/en-us/dotnet/api/system.security.accesscontrol.filesystemrights?view=windowsdesktop-5.0#fields) fields.\n\n \n```\nThese permissions are cumulative. If `:write` is specified, then it\nincludes `:read`. If `:full_control` is specified, then it includes\nboth `:write` and `:read`.\n\n(For those who know the Microsoft Windows API: `:read` corresponds\nto `GENERIC_READ`; `:write` corresponds to `GENERIC_WRITE`;\n`:read_execute` corresponds to `GENERIC_READ` and `GENERIC_EXECUTE`;\n`:modify` corresponds to `GENERIC_WRITE`, `GENERIC_READ`,\n`GENERIC_EXECUTE`, and `DELETE`; `:full_control` corresponds to\n`GENERIC_ALL`, which allows a user to change the owner and other\nmetadata about a file.)\n\n```\n `principal` Use to specify a group or user. The principal can be specified by either name or SID. When using name, this is identical to what is entered in the login box for Microsoft Windows, such as `user_name`, `domain\\user_name`, or `user_name@fully_qualified_domain_name`. When using a SID, you may use either the standard string representation of a SID (S-R-I-S-S) or one of the [SDDL string constants](https://docs.microsoft.com/en-us/windows/win32/secauthz/sid-strings). Chef Infra Client does not need to know if a principal is a user or a group.\n\n `option_type` A hash that contains advanced rights options. For example, the rights to a directory that only applies to the first level of children might look something like: `rights :write, 'domain\\group_name', :one_level_deep => true`. Possible option types:\n\n \n\n | Option Type | Description |\n| --- | --- |\n| `:applies_to_children` | Specify how permissions are applied to children. Possible values: `true` to inherit both child directories and files; `false` to not inherit any child directories or files; `:containers_only` to inherit only child directories (and not files); `:objects_only` to recursively inherit files (and not child directories). |\n| `:applies_to_self` | Indicates whether a permission is applied to the parent directory. Possible values: `true` to apply to the parent directory or file and its children; `false` to not apply only to child directories and files. |\n| `:one_level_deep` | Indicates the depth to which permissions will be applied. Possible values: `true` to apply only to the first level of children; `false` to apply to all children. |\n\n For example:\n\n \n```\nresource 'x.txt' do\n rights :read, 'S-1-1-0'\n rights :write, 'domain\\group'\n rights :full_control, 'group_name_or_user_name'\n rights :full_control, 'user_name', applies_to_children: true\nend\n\n```\n\nor:\n\n \n```\nrights :read, %w(Administrators Everyone)\nrights :full_control, 'Users', applies_to_children: true\nrights :write, 'Sally', applies_to_children: :containers_only, applies_to_self: false, one_level_deep: true\n\n```\n\nSome other important things to know when using the `rights` attribute:\n\n * Only inherited rights remain. All existing explicit rights on the object are removed and replaced.\n* If rights are not specified, nothing will be changed. Chef Infra Client does not clear out the rights on a file or directory if rights are not specified.\n* Changing inherited rights can be expensive. Microsoft Windows will propagate rights to all children recursively due to inheritance. This is a normal aspect of Microsoft Windows, so consider the frequency with which this type of action is necessary and take steps to control this type of action if performance is the primary consideration.\n\n Use the `deny_rights` property to deny specific rights to specific users. The ordering is independent of using the `rights` property. For example, it doesn’t matter if rights are granted to everyone is placed before or after `deny_rights :read, ['Julian', 'Lewis']`, both Julian and Lewis will be unable to read the document. For example:\n\n \n```\nresource 'x.txt' do\n rights :read, 'Everyone'\n rights :write, 'domain\\group'\n rights :full_control, 'group_name_or_user_name'\n rights :full_control, 'user_name', applies_to_children: true\n deny_rights :read, %w(Julian Lewis)\nend\n\n```\n\nor:\n\n \n```\ndeny_rights :full_control, ['Sally']\n\n```\n **Inheritance** By default, a file or directory inherits rights from its parent directory. Most of the time this is the preferred behavior, but sometimes it may be necessary to take steps to more specifically control rights. The `inherits` property can be used to specifically tell Chef Infra Client to apply (or not apply) inherited rights from its parent directory.\n\n For example, the following example specifies the rights for a directory:\n\n \n```\ndirectory 'C:\\mordor' do\n rights :read, 'MORDOR\\Minions'\n rights :full_control, 'MORDOR\\Sauron'\nend\n\n```\n\nand then the following example specifies how to use inheritance to deny access to the child directory:\n\n \n```\ndirectory 'C:\\mordor\\mount_doom' do\n rights :full_control, 'MORDOR\\Sauron'\n inherits false # Sauron is the only person who should have any sort of access\nend\n\n```\n\nIf the `deny_rights` permission were to be used instead, something could slip through unless all users and groups were denied.\n\n Another example also shows how to specify rights for a directory:\n\n \n```\ndirectory 'C:\\mordor' do\n rights :read, 'MORDOR\\Minions'\n rights :full_control, 'MORDOR\\Sauron'\n rights :write, 'SHIRE\\Frodo' # Who put that there I didn't put that there\nend\n\n```\n\nbut then not use the `inherits` property to deny those rights on a child directory:\n\n \n```\ndirectory 'C:\\mordor\\mount_doom' do\n deny_rights :read, 'MORDOR\\Minions' # Oops, not specific enough\nend\n\n```\n\nBecause the `inherits` property is not specified, Chef Infra Client will default it to `true`, which will ensure that security settings for existing files remain unchanged.\n\n \n Common Resource Functionality\n-----------------------------\n\n \n\n---\n\n Chef resources include common properties, notifications, and resource guards.\n\n ### Common Properties\n\n The following properties are common to every resource:\n\n `compile_time` **Ruby Type:** true, false | **Default Value:** `false`\n\n Control the phase during which the resource is run on the node. Set to true to run while the resource collection is being built (the `compile phase`). Set to false to run while Chef Infra Client is configuring the node (the `converge phase`).\n\n `ignore_failure` **Ruby Type:** true, false, :quiet | **Default Value:** `false`\n\n Continue running a recipe if a resource fails for any reason. `:quiet` will not display the full stack trace and the recipe will continue to run if a resource fails.\n\n `retries` **Ruby Type:** Integer | **Default Value:** `0`\n\n The number of attempts to catch exceptions and retry the resource.\n\n `retry_delay` **Ruby Type:** Integer | **Default Value:** `2`\n\n The delay in seconds between retry attempts.\n\n `sensitive` **Ruby Type:** true, false | **Default Value:** `false`\n\n Ensure that sensitive resource data is not logged by Chef Infra Client.\n\n ### Notifications\n\n `notifies` **Ruby Type:** Symbol, 'Chef::Resource[String]'\n\n A resource may notify another resource to take action when its state changes. Specify a `'resource[name]'`, the `:action` that resource should take, and then the `:timer` for that action. A resource may notify more than one resource; use a `notifies` statement for each resource to be notified.\n\n If the referenced resource does not exist, an error is raised. In contrast, `subscribes` will not fail if the source resource is not found.\n\n A timer specifies the point during a Chef Infra Client run at which a notification is run. The following timers are available:\n\n `:before` Specifies that the action on a notified resource should be run before processing the resource block in which the notification is located.\n\n `:delayed` Default. Specifies that a notification should be queued up, and then executed at the end of a Chef Infra Client run.\n\n \n`:immediate`, `:immediately`\n Specifies that a notification should be run immediately, per resource notified.\n\n The syntax for `notifies` is:\n\n \n```\nnotifies :action, 'resource[name]', :timer\n\n```\n `subscribes` **Ruby Type:** Symbol, 'Chef::Resource[String]'\n\n A resource may listen to another resource, and then take action if the state of the resource being listened to changes. Specify a `'resource[name]'`, the `:action` to be taken, and then the `:timer` for that action.\n\n Note that `subscribes` does not apply the specified action to the resource that it listens to - for example:\n\n \n```\nfile '/etc/nginx/ssl/example.crt' do\n mode '0600'\n owner 'root'\nend\n\nservice 'nginx' do\n subscribes :reload, 'file[/etc/nginx/ssl/example.crt]', :immediately\nend\n\n```\n\nIn this case the `subscribes` property reloads the `nginx` service whenever its certificate file, located under `/etc/nginx/ssl/example.crt`, is updated. `subscribes` does not make any changes to the certificate file itself, it merely listens for a change to the file, and executes the `:reload` action for its resource (in this example `nginx`) when a change is detected.\n\n If the other resource does not exist, the subscription will not raise an error. Contrast this with the stricter semantics of `notifies`, which will raise an error if the other resource does not exist.\n\n A timer specifies the point during a Chef Infra Client run at which a notification is run. The following timers are available:\n\n `:before` Specifies that the action on a notified resource should be run before processing the resource block in which the notification is located.\n\n `:delayed` Default. Specifies that a notification should be queued up, and then executed at the end of a Chef Infra Client run.\n\n \n`:immediate`, `:immediately`\n Specifies that a notification should be run immediately, per resource notified.\n\n The syntax for `subscribes` is:\n\n \n```\nsubscribes :action, 'resource[name]', :timer\n\n```\n ### Guards\n\n A guard property can be used to evaluate the state of a node during the execution phase of a Chef Infra Client run. Based on the results of this evaluation, a guard property is then used to tell Chef Infra Client if it should continue executing a resource. A guard property accepts either a string value or a Ruby block value:\n\n * A string is executed as a shell command. If the command returns `0`, the guard is applied. If the command returns any other value, then the guard property is not applied. String guards in a **powershell_script** run Windows PowerShell commands and may return `true` in addition to `0`.\n* A block is executed as Ruby code that must return either `true` or `false`. If the block returns `true`, the guard property is applied. If the block returns `false`, the guard property is not applied.\n\n A guard property is useful for ensuring that a resource is idempotent by allowing that resource to test for the desired state as it is being executed, and then if the desired state is present, for Chef Infra Client to do nothing.\n\n **Properties** The following properties can be used to define a guard that is evaluated during the execution phase of a Chef Infra Client run:\n\n `not_if` Prevent a resource from executing when the condition returns `true`.\n\n `only_if` Allow a resource to execute only if the condition returns `true`.\n\n File Specificity\n----------------\n\n A cookbook is frequently designed to work across many platforms and is often required to distribute a specific file to a specific platform. A cookbook can be designed to support the distribution of files across platforms, while ensuring that the correct file ends up on each system.\n\n The pattern for file specificity depends on two things: the lookup path and the source attribute. The first pattern that matches is used:\n\n 1. /host-$fqdn/$source\n2. /$platform-$platform_version/$source\n3. /$platform/$source\n4. /default/$source\n5. /$source\n\n Use an array with the `source` attribute to define an explicit lookup path. For example:\n\n \n```\nfile '/conf.py' do\n source ['#{node.chef_environment}.py', 'conf.py']\nend\n\n```\n\nThe following example emulates the entire file specificity pattern by defining it as an explicit path:\n\n \n```\nfile '/conf.py' do\n source %W(\n host-#{node['fqdn']}/conf.py\n#{node['platform']}-#{node['platform_version']}/conf.py\n#{node['platform']}/conf.py\n default/conf.py\n )\nend\n\n```\n\nA cookbook may have a `/files` directory structure like this:\n\n \n```\nfiles/\n host-foo.example.com\n ubuntu-20.04\n ubuntu-20\n ubuntu\n redhat-8.2\n redhat-7.8\n ...\n default\n\n```\n and a resource that looks something like the following:\n\n \n```\ncookbook_file '/usr/local/bin/apache2_module_conf_generate.pl' do\n source 'apache2_module_conf_generate.pl'\n mode '0755'\n owner 'root'\n group 'root'\nend\n\n```\n\nThis resource is matched in the same order as the `/files` directory structure. For a node that is running Ubuntu 20.04, the second item would be the matching item and the location to which the file identified in the **cookbook_file** resource would be distributed:\n\n \n```\nhost-foo.example.com/apache2_module_conf_generate.pl\nubuntu-20.04/apache2_module_conf_generate.pl\nubuntu-20/apache2_module_conf_generate.pl\nubuntu/apache2_module_conf_generate.pl\ndefault/apache2_module_conf_generate.pl\n\n```\n\nIf the `apache2_module_conf_generate.pl` file was located in the cookbook directory under `files/host-foo.example.com/`, the specified file(s) would only be copied to the machine with the domain name foo.example.com.\n\n **Host Notation**\n\n The naming of folders within cookbook directories must literally match the host notation used for file specificity matching. For example, if a host is named `foo.example.com`, the folder must be named `host-foo.example.com`.\n\n Examples\n--------\n\n \n\n---\n\n The following examples demonstrate various approaches for using the **cookbook_file** resource in recipes:\n\n Transfer a file\n\n \n```\ncookbook_file 'file.txt' do\n mode '0755'\nend\n\n```\n\nHandle cookbook_file and package resources in the same recipe\n\n When a **cookbook_file** resource and a **package** resource are both called from within the same recipe, use the `flush_cache` attribute to dump the in-memory Yum cache, and then use the repository immediately to ensure that the correct package is installed:\n\n \n```\ncookbook_file '/etc/yum.repos.d/custom.repo' do\n source 'custom'\n mode '0755'\nend\n\npackage 'only-in-custom-repo' do\n action :install\n flush_cache [ :before ]\nend\n\n```\n\nInstall repositories from a file, trigger a command, and force the internal cache to reload\n\n The following example shows how to install new Yum repositories from a file, where the installation of the repository triggers a creation of the Yum cache that forces the internal cache for Chef Infra Client to reload:\n\n \n```\nexecute 'create-yum-cache' do\n command 'yum -q makecache'\n action :nothing\nend\n\nruby_block 'reload-internal-yum-cache' do\n block do\n Chef::Provider::Package::Yum::YumCache.instance.reload\n end\n action :nothing\nend\n\ncookbook_file '/etc/yum.repos.d/custom.repo' do\n source 'custom'\n mode '0755'\n notifies :run, 'execute[create-yum-cache]', :immediately\n notifies :create, 'ruby_block[reload-internal-yum-cache]', :immediately\nend\n\n```\n\nUse a case statement\n\n The following example shows how a case statement can be used to handle a situation where an application needs to be installed on multiple platforms, but where the install directories are different paths, depending on the platform:\n\n \n```\ncookbook_file 'application.pm' do\n path case node['platform']\n when 'centos','redhat'\n '/usr/lib/version/1.2.3/dir/application.pm'\n when 'arch'\n '/usr/share/version/core_version/dir/application.pm'\n else\n '/etc/version/dir/application.pm'\n end\n source \"application-#{node['languages']['perl']['version']}.pm\"\n owner 'root'\n group 'root'\n mode '0755'\nend\n\n```\n\nManage dotfiles\n\n The following example shows using the **directory** and **cookbook_file** resources to manage dotfiles. The dotfiles are defined by a JSON data structure similar to:\n\n \n```\n\"files\": {\n \".zshrc\": {\n \"mode\": '0755',\n \"source\": \"dot-zshrc\"\n },\n \".bashrc\": {\n \"mode\": '0755',\n \"source\": \"dot-bashrc\"\n },\n \".bash_profile\": {\n \"mode\": '0755',\n \"source\": \"dot-bash_profile\"\n },\n }\n\n```\n\nand then the following resources manage the dotfiles:\n\n \n```\nif u.has_key?('files')\n u['files'].each do |filename, file_data|\n\n directory \"#{home_dir}/#{File.dirname(filename)}\" do\n recursive true\n mode '0755'\n end if file_data['subdir']\n\n cookbook_file \"#{home_dir}/#{filename}\" do\n source \"#{u['id']}/#{file_data['source']}\"\n owner 'u['id']'\n group 'group_id'\n mode 'file_data['mode']'\n ignore_failure true\n backup 0\n end\nend\n\n```\n \n\n © Chef Software, Inc. \nLicensed under the Creative Commons Attribution 3.0 Unported License. \nThe Chef™ Mark and Chef Logo are either registered trademarks/service marks or trademarks/servicemarks of Chef, in the United States and other countries and are used with Chef Inc's permission. \nWe are not affiliated with, endorsed or sponsored by Chef Inc. \n\n 'VALUE'})`. **Note**: These variables must exist for a command to be run successfully.\n\n `home` **Ruby Type:** String Set the `HOME` environment variable.\n\n `hour` **Ruby Type:** Integer, String | **Default Value:** `*` The hour at which the cron entry is to run (`0 - 23`).\n\n `mailto` **Ruby Type:** String Set the `MAILTO` environment variable.\n\n `minute` **Ruby Type:** Integer, String | **Default Value:** `*` The minute at which the cron entry should run (`0 - 59`).\n\n `month` **Ruby Type:** Integer, String | **Default Value:** `*` The month in the year on which a cron entry is to run (`1 - 12`, `jan-dec`, or `*`).\n\n `path` **Ruby Type:** String Set the `PATH` environment variable.\n\n `shell` **Ruby Type:** String Set the `SHELL` environment variable.\n\n `time` **Ruby Type:** Symbol **Allowed Values:** `:annually, :daily, :hourly, :midnight, :monthly, :reboot, :weekly, :yearly` A time interval.\n\n `time_out` **Ruby Type:** Hash | **Default Value:** `{}`\nA Hash of timeouts in the form of `({'OPTION' => 'VALUE'})`. Accepted valid options are:\n\n * `preserve-status` (BOOL, default: ‘false’),\n* `foreground` (BOOL, default: ‘false’),\n* `kill-after` (in seconds),\n* `signal` (a name like ‘HUP’ or a number)\n\n New in Chef Infra Client 15.7 \n\n `user` **Ruby Type:** String | **Default Value:** `root` The name of the user that runs the command. If the user property is changed, the original user for the crontab program continues to run until that crontab program is deleted. This property is not applicable on the AIX platform.\n\n `weekday` **Ruby Type:** Integer, String, Symbol | **Default Value:** `*` The day of the week on which this entry is to run (`0-7`, `mon-sun`, `monday-sunday`, or `*`), where Sunday is both `0` and `7`.\n\n \n Common Resource Functionality\n-----------------------------\n\n \n\n---\n\n Chef resources include common properties, notifications, and resource guards.\n\n ### Common Properties\n\n The following properties are common to every resource:\n\n `compile_time` **Ruby Type:** true, false | **Default Value:** `false`\n\n Control the phase during which the resource is run on the node. Set to true to run while the resource collection is being built (the `compile phase`). Set to false to run while Chef Infra Client is configuring the node (the `converge phase`).\n\n `ignore_failure` **Ruby Type:** true, false, :quiet | **Default Value:** `false`\n\n Continue running a recipe if a resource fails for any reason. `:quiet` will not display the full stack trace and the recipe will continue to run if a resource fails.\n\n `retries` **Ruby Type:** Integer | **Default Value:** `0`\n\n The number of attempts to catch exceptions and retry the resource.\n\n `retry_delay` **Ruby Type:** Integer | **Default Value:** `2`\n\n The delay in seconds between retry attempts.\n\n `sensitive` **Ruby Type:** true, false | **Default Value:** `false`\n\n Ensure that sensitive resource data is not logged by Chef Infra Client.\n\n ### Notifications\n\n `notifies` **Ruby Type:** Symbol, 'Chef::Resource[String]'\n\n A resource may notify another resource to take action when its state changes. Specify a `'resource[name]'`, the `:action` that resource should take, and then the `:timer` for that action. A resource may notify more than one resource; use a `notifies` statement for each resource to be notified.\n\n If the referenced resource does not exist, an error is raised. In contrast, `subscribes` will not fail if the source resource is not found.\n\n A timer specifies the point during a Chef Infra Client run at which a notification is run. The following timers are available:\n\n `:before` Specifies that the action on a notified resource should be run before processing the resource block in which the notification is located.\n\n `:delayed` Default. Specifies that a notification should be queued up, and then executed at the end of a Chef Infra Client run.\n\n \n`:immediate`, `:immediately`\n Specifies that a notification should be run immediately, per resource notified.\n\n The syntax for `notifies` is:\n\n \n```\nnotifies :action, 'resource[name]', :timer\n\n```\n `subscribes` **Ruby Type:** Symbol, 'Chef::Resource[String]'\n\n A resource may listen to another resource, and then take action if the state of the resource being listened to changes. Specify a `'resource[name]'`, the `:action` to be taken, and then the `:timer` for that action.\n\n Note that `subscribes` does not apply the specified action to the resource that it listens to - for example:\n\n \n```\nfile '/etc/nginx/ssl/example.crt' do\n mode '0600'\n owner 'root'\nend\n\nservice 'nginx' do\n subscribes :reload, 'file[/etc/nginx/ssl/example.crt]', :immediately\nend\n\n```\n\nIn this case the `subscribes` property reloads the `nginx` service whenever its certificate file, located under `/etc/nginx/ssl/example.crt`, is updated. `subscribes` does not make any changes to the certificate file itself, it merely listens for a change to the file, and executes the `:reload` action for its resource (in this example `nginx`) when a change is detected.\n\n If the other resource does not exist, the subscription will not raise an error. Contrast this with the stricter semantics of `notifies`, which will raise an error if the other resource does not exist.\n\n A timer specifies the point during a Chef Infra Client run at which a notification is run. The following timers are available:\n\n `:before` Specifies that the action on a notified resource should be run before processing the resource block in which the notification is located.\n\n `:delayed` Default. Specifies that a notification should be queued up, and then executed at the end of a Chef Infra Client run.\n\n \n`:immediate`, `:immediately`\n Specifies that a notification should be run immediately, per resource notified.\n\n The syntax for `subscribes` is:\n\n \n```\nsubscribes :action, 'resource[name]', :timer\n\n```\n ### Guards\n\n A guard property can be used to evaluate the state of a node during the execution phase of a Chef Infra Client run. Based on the results of this evaluation, a guard property is then used to tell Chef Infra Client if it should continue executing a resource. A guard property accepts either a string value or a Ruby block value:\n\n * A string is executed as a shell command. If the command returns `0`, the guard is applied. If the command returns any other value, then the guard property is not applied. String guards in a **powershell_script** run Windows PowerShell commands and may return `true` in addition to `0`.\n* A block is executed as Ruby code that must return either `true` or `false`. If the block returns `true`, the guard property is applied. If the block returns `false`, the guard property is not applied.\n\n A guard property is useful for ensuring that a resource is idempotent by allowing that resource to test for the desired state as it is being executed, and then if the desired state is present, for Chef Infra Client to do nothing.\n\n **Properties** The following properties can be used to define a guard that is evaluated during the execution phase of a Chef Infra Client run:\n\n `not_if` Prevent a resource from executing when the condition returns `true`.\n\n `only_if` Allow a resource to execute only if the condition returns `true`.\n\n Examples\n--------\n\n \n\n---\n\n The following examples demonstrate various approaches for using the **cron** resource in recipes:\n\n **Run a program at a specified interval**\n\n \n```\ncron 'noop' do\n hour '5'\n minute '0'\n command '/bin/true'\nend\n\n```\n\n**Run an entry if a folder exists**\n\n \n```\ncron 'ganglia_tomcat_thread_max' do\n command \"/usr/bin/gmetric\n -n 'tomcat threads max'\n -t uint32\n -v '/usr/local/bin/tomcat-stat --thread-max'\"\n only_if { ::File.exist?('/home/jboss') }\nend\n\n```\n\n**Run every Saturday, 8:00 AM**\n\n The following example shows a schedule that will run every hour at 8:00 each Saturday morning, and will then send an email to “” after each run.\n\n \n```\ncron 'name_of_cron_entry' do\n minute '0'\n hour '8'\n weekday '6'\n mailto ''\n action :create\nend\n\n```\n\n**Run once a week**\n\n \n```\ncron 'cookbooks_report' do\n minute '0'\n hour '0'\n weekday '1'\n user 'chefio'\n mailto ''\n home '/srv/supermarket/shared/system'\n command %W{\n cd /srv/supermarket/current &&\n env RUBYLIB=\"/srv/supermarket/current/lib\"\n RAILS_ASSET_ID=`git rev-parse HEAD` RAILS_ENV=\"#{rails_env}\"\n bundle exec rake cookbooks_report\n }.join(' ')\n action :create\nend\n\n```\n\n**Run only in November**\n\n The following example shows a schedule that will run at 8:00 PM, every weekday (Monday through Friday), but only in November:\n\n \n```\ncron 'name_of_cron_entry' do\n minute '0'\n hour '20'\n day '*'\n month '11'\n weekday '1-5'\n action :create\nend\n\n```\n \n\n © Chef Software, Inc. \nLicensed under the Creative Commons Attribution 3.0 Unported License. \nThe Chef™ Mark and Chef Logo are either registered trademarks/service marks or trademarks/servicemarks of Chef, in the United States and other countries and are used with Chef Inc's permission. \nWe are not affiliated with, endorsed or sponsored by Chef Inc. \n\n'\n home '/srv/supermarket/shared/system'\n command %W{\n cd /srv/supermarket/current &&\n env RUBYLIB=\"/srv/supermarket/current/lib\"\n RAILS_ASSET_ID=`git rev-parse HEAD` RAILS_ENV=\"#{rails_env}\"\n bundle exec rake cookbooks_report\n }.join(' ')\nend\n\n```\n The full syntax for all of the properties that are available to the **cron_d** resource is:\n\n```\ncron_d 'name' do\n command String\n comment String\n cron_name String # default value: 'name' unless specified\n day Integer, String # default value: \"*\"\n environment Hash # default value: {}\n home String\n hour Integer, String # default value: \"*\"\n mailto String\n minute Integer, String # default value: \"*\"\n mode String, Integer # default value: \"0600\"\n month Integer, String # default value: \"*\"\n path String\n predefined_value String\n random_delay Integer\n shell String\n time_out Hash # default value: {}\n user String # default value: \"root\"\n weekday Integer, String, Symbol # default value: \"*\"\n action Symbol # defaults to :create if not specified\nend\n```\n where:\n\n * `cron_d` is the resource.\n* `name` is the name given to the resource block.\n* `action` identifies which steps Chef Infra Client will take to bring the node into the desired state.\n* `command`, `comment`, `cron_name`, `day`, `environment`, `home`, `hour`, `mailto`, `minute`, `mode`, `month`, `path`, `predefined_value`, `random_delay`, `shell`, `time_out`, `user`, and `weekday` are the properties available to this resource.\n\n Actions\n-------\n\n \n\n---\n\n The **cron_d** resource has the following actions:\n\n `:create` (default) `:create_if_missing` Add a cron definition file to `/etc/cron.d`, but do not update an existing file. `:delete` Remove a cron definition file from `/etc/cron.d` if it exists. `:nothing` This resource block does not act unless notified by another resource to take action. Once notified, this resource block either runs immediately or is queued up to run at the end of a Chef Infra Client run. Properties\n----------\n\n \n\n---\n\n The **cron_d** resource has the following properties:\n\n `command` **Ruby Type:** String | `REQUIRED` The command to be run, or the path to a file that contains the command to be run.\n\n `comment` **Ruby Type:** String A comment to place in the cron.d file.\n\n `cron_name` **Ruby Type:** String | **Default Value:** `The resource block's name` An optional property to set the cron name if it differs from the resource block’s name.\n\n `day` **Ruby Type:** Integer, String | **Default Value:** `*` The day of month at which the cron entry should run (`1 - 31`).\n\n `environment` **Ruby Type:** Hash | **Default Value:** `{}` A Hash containing additional arbitrary environment variables under which the cron job will be run in the form of `({'ENV_VARIABLE' => 'VALUE'})`. **Note**: These variables must exist for a command to be run successfully.\n\n `home` **Ruby Type:** String Set the `HOME` environment variable.\n\n `hour` **Ruby Type:** Integer, String | **Default Value:** `*` The hour at which the cron entry is to run (`0 - 23`).\n\n `mailto` **Ruby Type:** String Set the `MAILTO` environment variable.\n\n `minute` **Ruby Type:** Integer, String | **Default Value:** `*` The minute at which the cron entry should run (`0 - 59`).\n\n `mode` **Ruby Type:** String, Integer | **Default Value:** `0600` The octal mode of the generated crontab file.\n\n `month` **Ruby Type:** Integer, String | **Default Value:** `*` The month in the year on which a cron entry is to run (`1 - 12`, `jan-dec`, or `*`).\n\n `path` **Ruby Type:** String Set the `PATH` environment variable.\n\n `predefined_value` **Ruby Type:** String **Allowed Values:** `\"@annually\", \"@daily\", \"@hourly\", \"@midnight\", \"@monthly\", \"@reboot\", \"@weekly\", \"@yearly\"` Schedule your cron job with one of the special predefined value instead of ** * pattern.\n\n `random_delay` **Ruby Type:** Integer Set the `RANDOM_DELAY` environment variable in the cron.d file.\n\n `shell` **Ruby Type:** String Set the `SHELL` environment variable.\n\n `time_out` **Ruby Type:** Hash | **Default Value:** `{}`\nA Hash of timeouts in the form of `({'OPTION' => 'VALUE'})`. Accepted valid options are:\n\n * `preserve-status` (BOOL, default: ‘false’),\n* `foreground` (BOOL, default: ‘false’),\n* `kill-after` (in seconds),\n* `signal` (a name like ‘HUP’ or a number)\n\n New in Chef Infra Client 15.7 \n\n `user` **Ruby Type:** String | **Default Value:** `root` The name of the user that runs the command.\n\n `weekday` **Ruby Type:** Integer, String, Symbol | **Default Value:** `*` The day of the week on which this entry is to run (`0-7`, `mon-sun`, `monday-sunday`, or `*`), where Sunday is both `0` and `7`.\n\n \n Common Resource Functionality\n-----------------------------\n\n \n\n---\n\n Chef resources include common properties, notifications, and resource guards.\n\n ### Common Properties\n\n The following properties are common to every resource:\n\n `compile_time` **Ruby Type:** true, false | **Default Value:** `false`\n\n Control the phase during which the resource is run on the node. Set to true to run while the resource collection is being built (the `compile phase`). Set to false to run while Chef Infra Client is configuring the node (the `converge phase`).\n\n `ignore_failure` **Ruby Type:** true, false, :quiet | **Default Value:** `false`\n\n Continue running a recipe if a resource fails for any reason. `:quiet` will not display the full stack trace and the recipe will continue to run if a resource fails.\n\n `retries` **Ruby Type:** Integer | **Default Value:** `0`\n\n The number of attempts to catch exceptions and retry the resource.\n\n `retry_delay` **Ruby Type:** Integer | **Default Value:** `2`\n\n The delay in seconds between retry attempts.\n\n `sensitive` **Ruby Type:** true, false | **Default Value:** `false`\n\n Ensure that sensitive resource data is not logged by Chef Infra Client.\n\n ### Notifications\n\n `notifies` **Ruby Type:** Symbol, 'Chef::Resource[String]'\n\n A resource may notify another resource to take action when its state changes. Specify a `'resource[name]'`, the `:action` that resource should take, and then the `:timer` for that action. A resource may notify more than one resource; use a `notifies` statement for each resource to be notified.\n\n If the referenced resource does not exist, an error is raised. In contrast, `subscribes` will not fail if the source resource is not found.\n\n A timer specifies the point during a Chef Infra Client run at which a notification is run. The following timers are available:\n\n `:before` Specifies that the action on a notified resource should be run before processing the resource block in which the notification is located.\n\n `:delayed` Default. Specifies that a notification should be queued up, and then executed at the end of a Chef Infra Client run.\n\n \n`:immediate`, `:immediately`\n Specifies that a notification should be run immediately, per resource notified.\n\n The syntax for `notifies` is:\n\n \n```\nnotifies :action, 'resource[name]', :timer\n\n```\n `subscribes` **Ruby Type:** Symbol, 'Chef::Resource[String]'\n\n A resource may listen to another resource, and then take action if the state of the resource being listened to changes. Specify a `'resource[name]'`, the `:action` to be taken, and then the `:timer` for that action.\n\n Note that `subscribes` does not apply the specified action to the resource that it listens to - for example:\n\n \n```\nfile '/etc/nginx/ssl/example.crt' do\n mode '0600'\n owner 'root'\nend\n\nservice 'nginx' do\n subscribes :reload, 'file[/etc/nginx/ssl/example.crt]', :immediately\nend\n\n```\n\nIn this case the `subscribes` property reloads the `nginx` service whenever its certificate file, located under `/etc/nginx/ssl/example.crt`, is updated. `subscribes` does not make any changes to the certificate file itself, it merely listens for a change to the file, and executes the `:reload` action for its resource (in this example `nginx`) when a change is detected.\n\n If the other resource does not exist, the subscription will not raise an error. Contrast this with the stricter semantics of `notifies`, which will raise an error if the other resource does not exist.\n\n A timer specifies the point during a Chef Infra Client run at which a notification is run. The following timers are available:\n\n `:before` Specifies that the action on a notified resource should be run before processing the resource block in which the notification is located.\n\n `:delayed` Default. Specifies that a notification should be queued up, and then executed at the end of a Chef Infra Client run.\n\n \n`:immediate`, `:immediately`\n Specifies that a notification should be run immediately, per resource notified.\n\n The syntax for `subscribes` is:\n\n \n```\nsubscribes :action, 'resource[name]', :timer\n\n```\n ### Guards\n\n A guard property can be used to evaluate the state of a node during the execution phase of a Chef Infra Client run. Based on the results of this evaluation, a guard property is then used to tell Chef Infra Client if it should continue executing a resource. A guard property accepts either a string value or a Ruby block value:\n\n * A string is executed as a shell command. If the command returns `0`, the guard is applied. If the command returns any other value, then the guard property is not applied. String guards in a **powershell_script** run Windows PowerShell commands and may return `true` in addition to `0`.\n* A block is executed as Ruby code that must return either `true` or `false`. If the block returns `true`, the guard property is applied. If the block returns `false`, the guard property is not applied.\n\n A guard property is useful for ensuring that a resource is idempotent by allowing that resource to test for the desired state as it is being executed, and then if the desired state is present, for Chef Infra Client to do nothing.\n\n **Properties** The following properties can be used to define a guard that is evaluated during the execution phase of a Chef Infra Client run:\n\n `not_if` Prevent a resource from executing when the condition returns `true`.\n\n `only_if` Allow a resource to execute only if the condition returns `true`.\n\n Examples\n--------\n\n \n\n---\n\n The following examples demonstrate various approaches for using the **cron_d** resource in recipes:\n\n **Run a program on the fifth hour of the day**\n\n \n```\ncron_d 'noop' do\n hour '5'\n minute '0'\n command '/bin/true'\nend\n\n```\n\n**Run an entry if a folder exists**\n\n \n```\ncron_d 'ganglia_tomcat_thread_max' do\n command \"/usr/bin/gmetric\n -n 'tomcat threads max'\n -t uint32\n -v '/usr/local/bin/tomcat-stat\n --thread-max'\"\n only_if { ::File.exist?('/home/jboss') }\nend\n\n```\n\n**Run an entry every Saturday, 8:00 AM**\n\n \n```\ncron_d 'name_of_cron_entry' do\n minute '0'\n hour '8'\n weekday '6'\n mailto ''\n command '/bin/true'\n action :create\nend\n\n```\n\n**Run an entry at 8:00 PM, every weekday (Monday through Friday), but only in November**\n\n \n```\ncron_d 'name_of_cron_entry' do\n minute '0'\n hour '20'\n day '*'\n month '11'\n weekday '1-5'\n command '/bin/true'\n action :create\nend\n\n```\n\n**Remove a cron job by name**:\n\n \n```\ncron_d 'job_to_remove' do\n action :delete\nend\n\n```\n \n\n © Chef Software, Inc. \nLicensed under the Creative Commons Attribution 3.0 Unported License. \nThe Chef™ Mark and Chef Logo are either registered trademarks/service marks or trademarks/servicemarks of Chef, in the United States and other countries and are used with Chef Inc's permission. \nWe are not affiliated with, endorsed or sponsored by Chef Inc. \n\n 'VALUE'})`. **Note**: These variables must exist for a command to be run successfully.\n\n `flags` **Ruby Type:** String One or more command line flags that are passed to the interpreter when a command is invoked.\n\n `group` **Ruby Type:** String, Integer The group name or group ID that must be changed before running a command.\n\n `returns` **Ruby Type:** Integer, Array | **Default Value:** `0` The return value for a command. This may be an array of accepted values. An exception is raised when the return value(s) do not match.\n\n `timeout` **Ruby Type:** Integer, Float | **Default Value:** `3600` The amount of time (in seconds) a command is to wait before timing out.\n\n `user` **Ruby Type:** String, Integer The user name or user ID that should be changed before running a command.\n\n `umask` **Ruby Type:** String, Integer The file mode creation mask, or umask.\n\n \n Common Resource Functionality\n-----------------------------\n\n \n\n---\n\n Chef resources include common properties, notifications, and resource guards.\n\n ### Common Properties\n\n The following properties are common to every resource:\n\n `compile_time` **Ruby Type:** true, false | **Default Value:** `false`\n\n Control the phase during which the resource is run on the node. Set to true to run while the resource collection is being built (the `compile phase`). Set to false to run while Chef Infra Client is configuring the node (the `converge phase`).\n\n `ignore_failure` **Ruby Type:** true, false, :quiet | **Default Value:** `false`\n\n Continue running a recipe if a resource fails for any reason. `:quiet` will not display the full stack trace and the recipe will continue to run if a resource fails.\n\n `retries` **Ruby Type:** Integer | **Default Value:** `0`\n\n The number of attempts to catch exceptions and retry the resource.\n\n `retry_delay` **Ruby Type:** Integer | **Default Value:** `2`\n\n The delay in seconds between retry attempts.\n\n `sensitive` **Ruby Type:** true, false | **Default Value:** `false`\n\n Ensure that sensitive resource data is not logged by Chef Infra Client.\n\n ### Notifications\n\n `notifies` **Ruby Type:** Symbol, 'Chef::Resource[String]'\n\n A resource may notify another resource to take action when its state changes. Specify a `'resource[name]'`, the `:action` that resource should take, and then the `:timer` for that action. A resource may notify more than one resource; use a `notifies` statement for each resource to be notified.\n\n If the referenced resource does not exist, an error is raised. In contrast, `subscribes` will not fail if the source resource is not found.\n\n A timer specifies the point during a Chef Infra Client run at which a notification is run. The following timers are available:\n\n `:before` Specifies that the action on a notified resource should be run before processing the resource block in which the notification is located.\n\n `:delayed` Default. Specifies that a notification should be queued up, and then executed at the end of a Chef Infra Client run.\n\n \n`:immediate`, `:immediately`\n Specifies that a notification should be run immediately, per resource notified.\n\n The syntax for `notifies` is:\n\n \n```\nnotifies :action, 'resource[name]', :timer\n\n```\n `subscribes` **Ruby Type:** Symbol, 'Chef::Resource[String]'\n\n A resource may listen to another resource, and then take action if the state of the resource being listened to changes. Specify a `'resource[name]'`, the `:action` to be taken, and then the `:timer` for that action.\n\n Note that `subscribes` does not apply the specified action to the resource that it listens to - for example:\n\n \n```\nfile '/etc/nginx/ssl/example.crt' do\n mode '0600'\n owner 'root'\nend\n\nservice 'nginx' do\n subscribes :reload, 'file[/etc/nginx/ssl/example.crt]', :immediately\nend\n\n```\n\nIn this case the `subscribes` property reloads the `nginx` service whenever its certificate file, located under `/etc/nginx/ssl/example.crt`, is updated. `subscribes` does not make any changes to the certificate file itself, it merely listens for a change to the file, and executes the `:reload` action for its resource (in this example `nginx`) when a change is detected.\n\n If the other resource does not exist, the subscription will not raise an error. Contrast this with the stricter semantics of `notifies`, which will raise an error if the other resource does not exist.\n\n A timer specifies the point during a Chef Infra Client run at which a notification is run. The following timers are available:\n\n `:before` Specifies that the action on a notified resource should be run before processing the resource block in which the notification is located.\n\n `:delayed` Default. Specifies that a notification should be queued up, and then executed at the end of a Chef Infra Client run.\n\n \n`:immediate`, `:immediately`\n Specifies that a notification should be run immediately, per resource notified.\n\n The syntax for `subscribes` is:\n\n \n```\nsubscribes :action, 'resource[name]', :timer\n\n```\n ### Guards\n\n A guard property can be used to evaluate the state of a node during the execution phase of a Chef Infra Client run. Based on the results of this evaluation, a guard property is then used to tell Chef Infra Client if it should continue executing a resource. A guard property accepts either a string value or a Ruby block value:\n\n * A string is executed as a shell command. If the command returns `0`, the guard is applied. If the command returns any other value, then the guard property is not applied. String guards in a **powershell_script** run Windows PowerShell commands and may return `true` in addition to `0`.\n* A block is executed as Ruby code that must return either `true` or `false`. If the block returns `true`, the guard property is applied. If the block returns `false`, the guard property is not applied.\n\n A guard property is useful for ensuring that a resource is idempotent by allowing that resource to test for the desired state as it is being executed, and then if the desired state is present, for Chef Infra Client to do nothing.\n\n **Properties** The following properties can be used to define a guard that is evaluated during the execution phase of a Chef Infra Client run:\n\n `not_if` Prevent a resource from executing when the condition returns `true`.\n\n `only_if` Allow a resource to execute only if the condition returns `true`.\n\n Examples\n--------\n\n \n\n---\n\n This resource does not have any examples.\n\n \n\n © Chef Software, Inc. \nLicensed under the Creative Commons Attribution 3.0 Unported License. \nThe Chef™ Mark and Chef Logo are either registered trademarks/service marks or trademarks/servicemarks of Chef, in the United States and other countries and are used with Chef Inc's permission. \nWe are not affiliated with, endorsed or sponsored by Chef Inc. \n\n, , ` where `` specifies the rights granted to the principal, `` is the group or user name, and `` is a Hash with one (or more) advanced rights options.\n\n ### Recursive Directories\n\n The **remote_directory** resource can be used to recursively create the path outside of remote directory structures, but the permissions of those outside paths are not managed. This is because the `recursive` attribute only applies `group`, `mode`, and `owner` attribute values to the remote directory itself and any inner directories the resource copies.\n\n A directory structure:\n\n \n```\n/foo\n /bar\n /baz\n\n```\n The following example shows a way create a file in the `/baz` directory:\n\n \n```\nremote_directory '/foo/bar/baz' do\n owner 'root'\n group 'root'\n mode '0755'\n action :create\nend\n\n```\n\nBut with this example, the `group`, `mode`, and `owner` attribute values will only be applied to `/baz`. Which is fine, if that’s what you want. But most of the time, when the entire `/foo/bar/baz` directory structure is not there, you must be explicit about each directory. For example:\n\n \n```\n%w( /foo /foo/bar /foo/bar/baz ).each do |path|\n remote_directory path do\n owner 'root'\n group 'root'\n mode '0755'\n end\nend\n\n```\n\nThis approach will create the correct hierarchy—`/foo`, then `/bar` in `/foo`, and then `/baz` in `/bar`—and also with the correct attribute values for `group`, `mode`, and `owner`.\n\n ### Windows File Security\n\n To support Microsoft Windows security, the **template**, **file**, **remote_file**, **cookbook_file**, **directory**, and **remote_directory** resources support the use of inheritance and access control lists (ACLs) within recipes. **Access Control Lists (ACLs)** The `rights` property can be used in a recipe to manage access control lists (ACLs), which allow permissions to be given to multiple users and groups. Use the `rights` property can be used as many times as necessary; Chef Infra Client will apply them to the file or directory as required. The syntax for the `rights` property is as follows:\n\n \n```\nrights permission, principal, option_type => value\n\n```\n\nwhere\n\n `permission` Use to specify which rights are granted to the `principal`. The possible values are: `:read`, `:write`, `read_execute`, `:modify`, `:full_control`, or an integer.\n\n Integers used for permissions must match the following list [FileSystemRights Enum](https://docs.microsoft.com/en-us/dotnet/api/system.security.accesscontrol.filesystemrights?view=windowsdesktop-5.0#fields) fields.\n\n \n```\nThese permissions are cumulative. If `:write` is specified, then it\nincludes `:read`. If `:full_control` is specified, then it includes\nboth `:write` and `:read`.\n\n(For those who know the Microsoft Windows API: `:read` corresponds\nto `GENERIC_READ`; `:write` corresponds to `GENERIC_WRITE`;\n`:read_execute` corresponds to `GENERIC_READ` and `GENERIC_EXECUTE`;\n`:modify` corresponds to `GENERIC_WRITE`, `GENERIC_READ`,\n`GENERIC_EXECUTE`, and `DELETE`; `:full_control` corresponds to\n`GENERIC_ALL`, which allows a user to change the owner and other\nmetadata about a file.)\n\n```\n `principal` Use to specify a group or user. The principal can be specified by either name or SID. When using name, this is identical to what is entered in the login box for Microsoft Windows, such as `user_name`, `domain\\user_name`, or `user_name@fully_qualified_domain_name`. When using a SID, you may use either the standard string representation of a SID (S-R-I-S-S) or one of the [SDDL string constants](https://docs.microsoft.com/en-us/windows/win32/secauthz/sid-strings). Chef Infra Client does not need to know if a principal is a user or a group.\n\n `option_type` A hash that contains advanced rights options. For example, the rights to a directory that only applies to the first level of children might look something like: `rights :write, 'domain\\group_name', :one_level_deep => true`. Possible option types:\n\n \n\n | Option Type | Description |\n| --- | --- |\n| `:applies_to_children` | Specify how permissions are applied to children. Possible values: `true` to inherit both child directories and files; `false` to not inherit any child directories or files; `:containers_only` to inherit only child directories (and not files); `:objects_only` to recursively inherit files (and not child directories). |\n| `:applies_to_self` | Indicates whether a permission is applied to the parent directory. Possible values: `true` to apply to the parent directory or file and its children; `false` to not apply only to child directories and files. |\n| `:one_level_deep` | Indicates the depth to which permissions will be applied. Possible values: `true` to apply only to the first level of children; `false` to apply to all children. |\n\n For example:\n\n \n```\nresource 'x.txt' do\n rights :read, 'S-1-1-0'\n rights :write, 'domain\\group'\n rights :full_control, 'group_name_or_user_name'\n rights :full_control, 'user_name', applies_to_children: true\nend\n\n```\n\nor:\n\n \n```\nrights :read, %w(Administrators Everyone)\nrights :full_control, 'Users', applies_to_children: true\nrights :write, 'Sally', applies_to_children: :containers_only, applies_to_self: false, one_level_deep: true\n\n```\n\nSome other important things to know when using the `rights` attribute:\n\n * Only inherited rights remain. All existing explicit rights on the object are removed and replaced.\n* If rights are not specified, nothing will be changed. Chef Infra Client does not clear out the rights on a file or directory if rights are not specified.\n* Changing inherited rights can be expensive. Microsoft Windows will propagate rights to all children recursively due to inheritance. This is a normal aspect of Microsoft Windows, so consider the frequency with which this type of action is necessary and take steps to control this type of action if performance is the primary consideration.\n\n Use the `deny_rights` property to deny specific rights to specific users. The ordering is independent of using the `rights` property. For example, it doesn’t matter if rights are granted to everyone is placed before or after `deny_rights :read, ['Julian', 'Lewis']`, both Julian and Lewis will be unable to read the document. For example:\n\n \n```\nresource 'x.txt' do\n rights :read, 'Everyone'\n rights :write, 'domain\\group'\n rights :full_control, 'group_name_or_user_name'\n rights :full_control, 'user_name', applies_to_children: true\n deny_rights :read, %w(Julian Lewis)\nend\n\n```\n\nor:\n\n \n```\ndeny_rights :full_control, ['Sally']\n\n```\n **Inheritance** By default, a file or directory inherits rights from its parent directory. Most of the time this is the preferred behavior, but sometimes it may be necessary to take steps to more specifically control rights. The `inherits` property can be used to specifically tell Chef Infra Client to apply (or not apply) inherited rights from its parent directory.\n\n For example, the following example specifies the rights for a directory:\n\n \n```\ndirectory 'C:\\mordor' do\n rights :read, 'MORDOR\\Minions'\n rights :full_control, 'MORDOR\\Sauron'\nend\n\n```\n\nand then the following example specifies how to use inheritance to deny access to the child directory:\n\n \n```\ndirectory 'C:\\mordor\\mount_doom' do\n rights :full_control, 'MORDOR\\Sauron'\n inherits false # Sauron is the only person who should have any sort of access\nend\n\n```\n\nIf the `deny_rights` permission were to be used instead, something could slip through unless all users and groups were denied.\n\n Another example also shows how to specify rights for a directory:\n\n \n```\ndirectory 'C:\\mordor' do\n rights :read, 'MORDOR\\Minions'\n rights :full_control, 'MORDOR\\Sauron'\n rights :write, 'SHIRE\\Frodo' # Who put that there I didn't put that there\nend\n\n```\n\nbut then not use the `inherits` property to deny those rights on a child directory:\n\n \n```\ndirectory 'C:\\mordor\\mount_doom' do\n deny_rights :read, 'MORDOR\\Minions' # Oops, not specific enough\nend\n\n```\n\nBecause the `inherits` property is not specified, Chef Infra Client will default it to `true`, which will ensure that security settings for existing files remain unchanged.\n\n \n Common Resource Functionality\n-----------------------------\n\n \n\n---\n\n Chef resources include common properties, notifications, and resource guards.\n\n ### Common Properties\n\n The following properties are common to every resource:\n\n `compile_time` **Ruby Type:** true, false | **Default Value:** `false`\n\n Control the phase during which the resource is run on the node. Set to true to run while the resource collection is being built (the `compile phase`). Set to false to run while Chef Infra Client is configuring the node (the `converge phase`).\n\n `ignore_failure` **Ruby Type:** true, false, :quiet | **Default Value:** `false`\n\n Continue running a recipe if a resource fails for any reason. `:quiet` will not display the full stack trace and the recipe will continue to run if a resource fails.\n\n `retries` **Ruby Type:** Integer | **Default Value:** `0`\n\n The number of attempts to catch exceptions and retry the resource.\n\n `retry_delay` **Ruby Type:** Integer | **Default Value:** `2`\n\n The delay in seconds between retry attempts.\n\n `sensitive` **Ruby Type:** true, false | **Default Value:** `false`\n\n Ensure that sensitive resource data is not logged by Chef Infra Client.\n\n ### Notifications\n\n `notifies` **Ruby Type:** Symbol, 'Chef::Resource[String]'\n\n A resource may notify another resource to take action when its state changes. Specify a `'resource[name]'`, the `:action` that resource should take, and then the `:timer` for that action. A resource may notify more than one resource; use a `notifies` statement for each resource to be notified.\n\n If the referenced resource does not exist, an error is raised. In contrast, `subscribes` will not fail if the source resource is not found.\n\n A timer specifies the point during a Chef Infra Client run at which a notification is run. The following timers are available:\n\n `:before` Specifies that the action on a notified resource should be run before processing the resource block in which the notification is located.\n\n `:delayed` Default. Specifies that a notification should be queued up, and then executed at the end of a Chef Infra Client run.\n\n \n`:immediate`, `:immediately`\n Specifies that a notification should be run immediately, per resource notified.\n\n The syntax for `notifies` is:\n\n \n```\nnotifies :action, 'resource[name]', :timer\n\n```\n `subscribes` **Ruby Type:** Symbol, 'Chef::Resource[String]'\n\n A resource may listen to another resource, and then take action if the state of the resource being listened to changes. Specify a `'resource[name]'`, the `:action` to be taken, and then the `:timer` for that action.\n\n Note that `subscribes` does not apply the specified action to the resource that it listens to - for example:\n\n \n```\nfile '/etc/nginx/ssl/example.crt' do\n mode '0600'\n owner 'root'\nend\n\nservice 'nginx' do\n subscribes :reload, 'file[/etc/nginx/ssl/example.crt]', :immediately\nend\n\n```\n\nIn this case the `subscribes` property reloads the `nginx` service whenever its certificate file, located under `/etc/nginx/ssl/example.crt`, is updated. `subscribes` does not make any changes to the certificate file itself, it merely listens for a change to the file, and executes the `:reload` action for its resource (in this example `nginx`) when a change is detected.\n\n If the other resource does not exist, the subscription will not raise an error. Contrast this with the stricter semantics of `notifies`, which will raise an error if the other resource does not exist.\n\n A timer specifies the point during a Chef Infra Client run at which a notification is run. The following timers are available:\n\n `:before` Specifies that the action on a notified resource should be run before processing the resource block in which the notification is located.\n\n `:delayed` Default. Specifies that a notification should be queued up, and then executed at the end of a Chef Infra Client run.\n\n \n`:immediate`, `:immediately`\n Specifies that a notification should be run immediately, per resource notified.\n\n The syntax for `subscribes` is:\n\n \n```\nsubscribes :action, 'resource[name]', :timer\n\n```\n ### Guards\n\n A guard property can be used to evaluate the state of a node during the execution phase of a Chef Infra Client run. Based on the results of this evaluation, a guard property is then used to tell Chef Infra Client if it should continue executing a resource. A guard property accepts either a string value or a Ruby block value:\n\n * A string is executed as a shell command. If the command returns `0`, the guard is applied. If the command returns any other value, then the guard property is not applied. String guards in a **powershell_script** run Windows PowerShell commands and may return `true` in addition to `0`.\n* A block is executed as Ruby code that must return either `true` or `false`. If the block returns `true`, the guard property is applied. If the block returns `false`, the guard property is not applied.\n\n A guard property is useful for ensuring that a resource is idempotent by allowing that resource to test for the desired state as it is being executed, and then if the desired state is present, for Chef Infra Client to do nothing.\n\n **Properties** The following properties can be used to define a guard that is evaluated during the execution phase of a Chef Infra Client run:\n\n `not_if` Prevent a resource from executing when the condition returns `true`.\n\n `only_if` Allow a resource to execute only if the condition returns `true`.\n\n Examples\n--------\n\n \n\n---\n\n The following examples demonstrate various approaches for using the **directory** resource in recipes:\n\n Create a directory\n\n \n```\ndirectory '/tmp/something' do\n owner 'root'\n group 'root'\n mode '0755'\n action :create\nend\n\n```\n\nCreate a directory in Microsoft Windows\n\n \n```\ndirectory \"C:\\\\tmp\\\\something\" do\n rights :full_control, \"DOMAIN\\\\User\"\n inherits false\n action :create\nend\n\n```\n\nor:\n\n \n```\ndirectory 'C:\\tmp\\something' do\n rights :full_control, 'DOMAIN\\User'\n inherits false\n action :create\nend\n\n```\n Note\n\n The difference between the two previous examples is the single- versus double-quoted strings, where if the double quotes are used, the backslash character (`\\`) must be escaped using the Ruby escape character (which is a backslash).\n\n Create a directory recursively\n\n \n```\n%w{dir1 dir2 dir3}.each do |dir|\n directory \"/tmp/mydirs/#{dir}\" do\n mode '0755'\n owner 'root'\n group 'root'\n action :create\n recursive true\n end\nend\n\n```\n\nDelete a directory\n\n \n```\ndirectory '/tmp/something' do\n recursive true\n action :delete\nend\n\n```\n\nSet directory permissions using a variable\n\n The following example shows how read/write/execute permissions can be set using a variable named `user_home`, and then for owners and groups on any matching node:\n\n \n```\nuser_home = \"/#{node[:matching_node][:user]}\"\n\ndirectory user_home do\n owner 'node[:matching_node][:user]'\n group 'node[:matching_node][:group]'\n mode '0755'\n action :create\nend\n\n```\n\nwhere `matching_node` represents a type of node. For example, if the `user_home` variable specified `{node[:nginx]...}`, a recipe might look similar to:\n\n \n```\nuser_home = \"/#{node[:nginx][:user]}\"\n\ndirectory user_home do\n owner 'node[:nginx][:user]'\n group 'node[:nginx][:group]'\n mode '0755'\n action :create\nend\n\n```\n\nSet directory permissions for a specific type of node\n\n The following example shows how permissions can be set for the `/certificates` directory on any node that is running Nginx. In this example, permissions are being set for the `owner` and `group` properties as `root`, and then read/write permissions are granted to the root.\n\n \n```\ndirectory \"#{node[:nginx][:dir]}/shared/certificates\" do\n owner 'root'\n group 'root'\n mode '0755'\n recursive true\nend\n\n```\n\nReload the configuration\n\n The following example shows how to reload the configuration of a chef-client using the **remote_file** resource to:\n\n * using an if statement to check whether the plugins on a node are the latest versions\n* identify the location from which Ohai plugins are stored\n* using the `notifies` property and a **ruby_block** resource to trigger an update (if required) and to then reload the client.rb file.\n\n \n```\ndirectory 'node[:ohai][:plugin_path]' do\n owner 'chef'\n recursive true\nend\n\nruby_block 'reload_config' do\n block do\n Chef::Config.from_file('/etc/chef/client.rb')\n end\n action :nothing\nend\n\nif node[:ohai].key?(:plugins)\n node[:ohai][:plugins].each do |plugin|\n remote_file node[:ohai][:plugin_path] +\"/#{plugin}\" do\n source plugin\n owner 'chef'\n notifies :run, 'ruby_block[reload_config]', :immediately\n end\n end\nend\n\n```\n\nManage dotfiles\n\n The following example shows using the **directory** and **cookbook_file** resources to manage dotfiles. The dotfiles are defined by a JSON data structure similar to:\n\n \n```\n\"files\": {\n \".zshrc\": {\n \"mode\": '0755',\n \"source\": \"dot-zshrc\"\n },\n \".bashrc\": {\n \"mode\": '0755',\n \"source\": \"dot-bashrc\"\n },\n \".bash_profile\": {\n \"mode\": '0755',\n \"source\": \"dot-bash_profile\"\n },\n }\n\n```\n\nand then the following resources manage the dotfiles:\n\n \n```\nif u.has_key?('files')\n u['files'].each do |filename, file_data|\n\n directory \"#{home_dir}/#{File.dirname(filename)}\" do\n recursive true\n mode '0755'\n end if file_data['subdir']\n\n cookbook_file \"#{home_dir}/#{filename}\" do\n source \"#{u['id']}/#{file_data['source']}\"\n owner 'u['id']'\n group 'group_id'\n mode 'file_data['mode']'\n ignore_failure true\n backup 0\n end\nend\n\n```\n \n\n © Chef Software, Inc. \nLicensed under the Creative Commons Attribution 3.0 Unported License. \nThe Chef™ Mark and Chef Logo are either registered trademarks/service marks or trademarks/servicemarks of Chef, in the United States and other countries and are used with Chef Inc's permission. \nWe are not affiliated with, endorsed or sponsored by Chef Inc. \n\n ‘VALUE’}.\n\n `source` **Ruby Type:** String, Array The path to a package in the local file system.\n\n `timeout` **Ruby Type:** String, Integer The amount of time (in seconds) to wait before timing out.\n\n `version` **Ruby Type:** String, Array The version of a package to be installed or upgraded.\n\n ### Multiple Packages\n\n A resource may specify multiple packages and/or versions for platforms that use Apt, Chocolatey, DNF, Homebrew, Pacman, or Zypper package managers. Specifying multiple packages and/or versions allows a single transaction to:\n\n * Download the specified packages and versions via a single HTTP transaction\n* Update or install multiple packages with a single resource during a Chef Infra Client run\n\n For example, installing multiple packages:\n\n \n```\npackage %w(package1 package2)\n\n```\n\nInstalling multiple packages with versions:\n\n \n```\npackage %w(package1 package2) do\n version [ '1.3.4-2', '4.3.6-1']\nend\n\n```\n\nUpgrading multiple packages:\n\n \n```\npackage %w(package1 package2) do\n action :upgrade\nend\n\n```\n\nRemoving multiple packages:\n\n \n```\npackage %w(package1 package2) do\n action :remove\nend\n\n```\n\nPurging multiple packages:\n\n \n```\npackage %w(package1 package2) do\n action :purge\nend\n\n```\n\nNotifications, via an implicit name:\n\n \n```\npackage %w(package1 package2) do\n action :nothing\nend\n\nlog 'call a notification' do\n notifies :install, 'package[package1, package2]', :immediately\nend\n\n```\n\n Note\n\n Notifications and subscriptions do not need to be updated when packages and versions are added or removed from the `package_name` or `version` properties.\n\n \n Common Resource Functionality\n-----------------------------\n\n \n\n---\n\n Chef resources include common properties, notifications, and resource guards.\n\n ### Common Properties\n\n The following properties are common to every resource:\n\n `compile_time` **Ruby Type:** true, false | **Default Value:** `false`\n\n Control the phase during which the resource is run on the node. Set to true to run while the resource collection is being built (the `compile phase`). Set to false to run while Chef Infra Client is configuring the node (the `converge phase`).\n\n `ignore_failure` **Ruby Type:** true, false, :quiet | **Default Value:** `false`\n\n Continue running a recipe if a resource fails for any reason. `:quiet` will not display the full stack trace and the recipe will continue to run if a resource fails.\n\n `retries` **Ruby Type:** Integer | **Default Value:** `0`\n\n The number of attempts to catch exceptions and retry the resource.\n\n `retry_delay` **Ruby Type:** Integer | **Default Value:** `2`\n\n The delay in seconds between retry attempts.\n\n `sensitive` **Ruby Type:** true, false | **Default Value:** `false`\n\n Ensure that sensitive resource data is not logged by Chef Infra Client.\n\n ### Notifications\n\n `notifies` **Ruby Type:** Symbol, 'Chef::Resource[String]'\n\n A resource may notify another resource to take action when its state changes. Specify a `'resource[name]'`, the `:action` that resource should take, and then the `:timer` for that action. A resource may notify more than one resource; use a `notifies` statement for each resource to be notified.\n\n If the referenced resource does not exist, an error is raised. In contrast, `subscribes` will not fail if the source resource is not found.\n\n A timer specifies the point during a Chef Infra Client run at which a notification is run. The following timers are available:\n\n `:before` Specifies that the action on a notified resource should be run before processing the resource block in which the notification is located.\n\n `:delayed` Default. Specifies that a notification should be queued up, and then executed at the end of a Chef Infra Client run.\n\n \n`:immediate`, `:immediately`\n Specifies that a notification should be run immediately, per resource notified.\n\n The syntax for `notifies` is:\n\n \n```\nnotifies :action, 'resource[name]', :timer\n\n```\n `subscribes` **Ruby Type:** Symbol, 'Chef::Resource[String]'\n\n A resource may listen to another resource, and then take action if the state of the resource being listened to changes. Specify a `'resource[name]'`, the `:action` to be taken, and then the `:timer` for that action.\n\n Note that `subscribes` does not apply the specified action to the resource that it listens to - for example:\n\n \n```\nfile '/etc/nginx/ssl/example.crt' do\n mode '0600'\n owner 'root'\nend\n\nservice 'nginx' do\n subscribes :reload, 'file[/etc/nginx/ssl/example.crt]', :immediately\nend\n\n```\n\nIn this case the `subscribes` property reloads the `nginx` service whenever its certificate file, located under `/etc/nginx/ssl/example.crt`, is updated. `subscribes` does not make any changes to the certificate file itself, it merely listens for a change to the file, and executes the `:reload` action for its resource (in this example `nginx`) when a change is detected.\n\n If the other resource does not exist, the subscription will not raise an error. Contrast this with the stricter semantics of `notifies`, which will raise an error if the other resource does not exist.\n\n A timer specifies the point during a Chef Infra Client run at which a notification is run. The following timers are available:\n\n `:before` Specifies that the action on a notified resource should be run before processing the resource block in which the notification is located.\n\n `:delayed` Default. Specifies that a notification should be queued up, and then executed at the end of a Chef Infra Client run.\n\n \n`:immediate`, `:immediately`\n Specifies that a notification should be run immediately, per resource notified.\n\n The syntax for `subscribes` is:\n\n \n```\nsubscribes :action, 'resource[name]', :timer\n\n```\n ### Guards\n\n A guard property can be used to evaluate the state of a node during the execution phase of a Chef Infra Client run. Based on the results of this evaluation, a guard property is then used to tell Chef Infra Client if it should continue executing a resource. A guard property accepts either a string value or a Ruby block value:\n\n * A string is executed as a shell command. If the command returns `0`, the guard is applied. If the command returns any other value, then the guard property is not applied. String guards in a **powershell_script** run Windows PowerShell commands and may return `true` in addition to `0`.\n* A block is executed as Ruby code that must return either `true` or `false`. If the block returns `true`, the guard property is applied. If the block returns `false`, the guard property is not applied.\n\n A guard property is useful for ensuring that a resource is idempotent by allowing that resource to test for the desired state as it is being executed, and then if the desired state is present, for Chef Infra Client to do nothing.\n\n **Properties** The following properties can be used to define a guard that is evaluated during the execution phase of a Chef Infra Client run:\n\n `not_if` Prevent a resource from executing when the condition returns `true`.\n\n `only_if` Allow a resource to execute only if the condition returns `true`.\n\n ### Multiple Packages\n\n A resource may specify multiple packages and/or versions for platforms that use Apt, Chocolatey, DNF, Homebrew, Pacman, or Zypper package managers. Specifying multiple packages and/or versions allows a single transaction to:\n\n * Download the specified packages and versions via a single HTTP transaction\n* Update or install multiple packages with a single resource during a Chef Infra Client run\n\n For example, installing multiple packages:\n\n \n```\npackage %w(package1 package2)\n\n```\n\nInstalling multiple packages with versions:\n\n \n```\npackage %w(package1 package2) do\n version [ '1.3.4-2', '4.3.6-1']\nend\n\n```\n\nUpgrading multiple packages:\n\n \n```\npackage %w(package1 package2) do\n action :upgrade\nend\n\n```\n\nRemoving multiple packages:\n\n \n```\npackage %w(package1 package2) do\n action :remove\nend\n\n```\n\nPurging multiple packages:\n\n \n```\npackage %w(package1 package2) do\n action :purge\nend\n\n```\n\nNotifications, via an implicit name:\n\n \n```\npackage %w(package1 package2) do\n action :nothing\nend\n\nlog 'call a notification' do\n notifies :install, 'package[package1, package2]', :immediately\nend\n\n```\n\n Note\n\n Notifications and subscriptions do not need to be updated when packages and versions are added or removed from the `package_name` or `version` properties.\n\n Examples\n--------\n\n \n\n---\n\n The following examples demonstrate various approaches for using the **dpkg_package** resource in recipes:\n\n Install a package\n\n \n```\ndpkg_package 'wget_1.13.4-2ubuntu1.4_amd64.deb' do\n source '/foo/bar/wget_1.13.4-2ubuntu1.4_amd64.deb'\n action :install\nend\n\n```\n \n\n © Chef Software, Inc. \nLicensed under the Creative Commons Attribution 3.0 Unported License. \nThe Chef™ Mark and Chef Logo are either registered trademarks/service marks or trademarks/servicemarks of Chef, in the United States and other countries and are used with Chef Inc's permission. \nWe are not affiliated with, endorsed or sponsored by Chef Inc. \n\nfalse, \"after\"=>false}\n options String, Array\n package_name String, Array\n source String\n timeout String, Integer\n version String, Array\n action Symbol # defaults to :install if not specified\nend\n```\n where:\n\n * `dnf_package` is the resource.\n* `name` is the name given to the resource block.\n* `action` identifies which steps Chef Infra Client will take to bring the node into the desired state.\n* `allow_downgrade`, `arch`, `flush_cache`, `options`, `package_name`, `source`, `timeout`, and `version` are the properties available to this resource.\n\n Actions\n-------\n\n \n\n---\n\n The **dnf_package** resource has the following actions:\n\n `:install` Install a package. If a version is specified, install the specified version of the package. (default) `:lock` Locks the DNF package to a specific version. `:nothing` This resource block does not act unless notified by another resource to take action. Once notified, this resource block either runs immediately or is queued up to run at the end of a Chef Infra Client run. `:purge` Purge a package. This action typically removes the configuration files as well as the package. `:remove` Remove a package. `:unlock` Unlocks the DNF package so that it can be upgraded to a newer version. `:upgrade` Install a package and/or ensure that a package is the latest version. Properties\n----------\n\n \n\n---\n\n The **dnf_package** resource has the following properties:\n\n `allow_downgrade` **Ruby Type:** true, false | **Default Value:** `true` Allow downgrading a package to satisfy requested version requirements.\n\n `arch` **Ruby Type:** String, Array The architecture of the package to be installed or upgraded. This value can also be passed as part of the package name.\n\n `flush_cache` **Ruby Type:** Hash | **Default Value:** `{\"before\"=>false, \"after\"=>false}`\nFlush the in-memory cache before or after a DNF operation that installs, upgrades, or removes a package.\n\n DNF automatically synchronizes remote metadata to a local cache. Chef Infra Client creates a copy of the local cache, and then stores it in-memory during a Chef Infra Client run. The in-memory cache allows packages to be installed during a Chef Infra Client run without the need to continue synchronizing the remote metadata to the local cache while a Chef Infra Client run is in-progress.\n\n As an array:\n\n \n```\ndnf_package 'some-package' do\n #...\n flush_cache [ :before ]\n #...\nend\n\n```\n\nand as a Hash:\n\n \n```\ndnf_package 'some-package' do\n #...\n flush_cache( { :after => true } )\n #...\nend\n\n```\n Note\n\n The `flush_cache` property does not flush the local DNF cache! Use dnf tools—`dnf clean metadata`, `dnf clean packages`, `dnf clean all`—to clean the local DNF cache.\n\n `options` **Ruby Type:** String, Array One (or more) additional command options that are passed to the command.\n\n `package_name` **Ruby Type:** String, Array An optional property to set the package name if it differs from the resource block’s name.\n\n `source` **Ruby Type:** String The optional path to a package on the local file system.\n\n `timeout` **Ruby Type:** String, Integer The amount of time (in seconds) to wait before timing out.\n\n `version` **Ruby Type:** String, Array The version of a package to be installed or upgraded. This property is ignored when using the `:upgrade` action.\n\n ### Multiple Packages\n\n A resource may specify multiple packages and/or versions for platforms that use Apt, Chocolatey, DNF, Homebrew, Pacman, or Zypper package managers. Specifying multiple packages and/or versions allows a single transaction to:\n\n * Download the specified packages and versions via a single HTTP transaction\n* Update or install multiple packages with a single resource during a Chef Infra Client run\n\n For example, installing multiple packages:\n\n \n```\npackage %w(package1 package2)\n\n```\n\nInstalling multiple packages with versions:\n\n \n```\npackage %w(package1 package2) do\n version [ '1.3.4-2', '4.3.6-1']\nend\n\n```\n\nUpgrading multiple packages:\n\n \n```\npackage %w(package1 package2) do\n action :upgrade\nend\n\n```\n\nRemoving multiple packages:\n\n \n```\npackage %w(package1 package2) do\n action :remove\nend\n\n```\n\nPurging multiple packages:\n\n \n```\npackage %w(package1 package2) do\n action :purge\nend\n\n```\n\nNotifications, via an implicit name:\n\n \n```\npackage %w(package1 package2) do\n action :nothing\nend\n\nlog 'call a notification' do\n notifies :install, 'package[package1, package2]', :immediately\nend\n\n```\n\n Note\n\n Notifications and subscriptions do not need to be updated when packages and versions are added or removed from the `package_name` or `version` properties.\n\n \n Common Resource Functionality\n-----------------------------\n\n \n\n---\n\n Chef resources include common properties, notifications, and resource guards.\n\n ### Common Properties\n\n The following properties are common to every resource:\n\n `compile_time` **Ruby Type:** true, false | **Default Value:** `false`\n\n Control the phase during which the resource is run on the node. Set to true to run while the resource collection is being built (the `compile phase`). Set to false to run while Chef Infra Client is configuring the node (the `converge phase`).\n\n `ignore_failure` **Ruby Type:** true, false, :quiet | **Default Value:** `false`\n\n Continue running a recipe if a resource fails for any reason. `:quiet` will not display the full stack trace and the recipe will continue to run if a resource fails.\n\n `retries` **Ruby Type:** Integer | **Default Value:** `0`\n\n The number of attempts to catch exceptions and retry the resource.\n\n `retry_delay` **Ruby Type:** Integer | **Default Value:** `2`\n\n The delay in seconds between retry attempts.\n\n `sensitive` **Ruby Type:** true, false | **Default Value:** `false`\n\n Ensure that sensitive resource data is not logged by Chef Infra Client.\n\n ### Notifications\n\n `notifies` **Ruby Type:** Symbol, 'Chef::Resource[String]'\n\n A resource may notify another resource to take action when its state changes. Specify a `'resource[name]'`, the `:action` that resource should take, and then the `:timer` for that action. A resource may notify more than one resource; use a `notifies` statement for each resource to be notified.\n\n If the referenced resource does not exist, an error is raised. In contrast, `subscribes` will not fail if the source resource is not found.\n\n A timer specifies the point during a Chef Infra Client run at which a notification is run. The following timers are available:\n\n `:before` Specifies that the action on a notified resource should be run before processing the resource block in which the notification is located.\n\n `:delayed` Default. Specifies that a notification should be queued up, and then executed at the end of a Chef Infra Client run.\n\n \n`:immediate`, `:immediately`\n Specifies that a notification should be run immediately, per resource notified.\n\n The syntax for `notifies` is:\n\n \n```\nnotifies :action, 'resource[name]', :timer\n\n```\n `subscribes` **Ruby Type:** Symbol, 'Chef::Resource[String]'\n\n A resource may listen to another resource, and then take action if the state of the resource being listened to changes. Specify a `'resource[name]'`, the `:action` to be taken, and then the `:timer` for that action.\n\n Note that `subscribes` does not apply the specified action to the resource that it listens to - for example:\n\n \n```\nfile '/etc/nginx/ssl/example.crt' do\n mode '0600'\n owner 'root'\nend\n\nservice 'nginx' do\n subscribes :reload, 'file[/etc/nginx/ssl/example.crt]', :immediately\nend\n\n```\n\nIn this case the `subscribes` property reloads the `nginx` service whenever its certificate file, located under `/etc/nginx/ssl/example.crt`, is updated. `subscribes` does not make any changes to the certificate file itself, it merely listens for a change to the file, and executes the `:reload` action for its resource (in this example `nginx`) when a change is detected.\n\n If the other resource does not exist, the subscription will not raise an error. Contrast this with the stricter semantics of `notifies`, which will raise an error if the other resource does not exist.\n\n A timer specifies the point during a Chef Infra Client run at which a notification is run. The following timers are available:\n\n `:before` Specifies that the action on a notified resource should be run before processing the resource block in which the notification is located.\n\n `:delayed` Default. Specifies that a notification should be queued up, and then executed at the end of a Chef Infra Client run.\n\n \n`:immediate`, `:immediately`\n Specifies that a notification should be run immediately, per resource notified.\n\n The syntax for `subscribes` is:\n\n \n```\nsubscribes :action, 'resource[name]', :timer\n\n```\n ### Guards\n\n A guard property can be used to evaluate the state of a node during the execution phase of a Chef Infra Client run. Based on the results of this evaluation, a guard property is then used to tell Chef Infra Client if it should continue executing a resource. A guard property accepts either a string value or a Ruby block value:\n\n * A string is executed as a shell command. If the command returns `0`, the guard is applied. If the command returns any other value, then the guard property is not applied. String guards in a **powershell_script** run Windows PowerShell commands and may return `true` in addition to `0`.\n* A block is executed as Ruby code that must return either `true` or `false`. If the block returns `true`, the guard property is applied. If the block returns `false`, the guard property is not applied.\n\n A guard property is useful for ensuring that a resource is idempotent by allowing that resource to test for the desired state as it is being executed, and then if the desired state is present, for Chef Infra Client to do nothing.\n\n **Properties** The following properties can be used to define a guard that is evaluated during the execution phase of a Chef Infra Client run:\n\n `not_if` Prevent a resource from executing when the condition returns `true`.\n\n `only_if` Allow a resource to execute only if the condition returns `true`.\n\n ### Multiple Packages\n\n A resource may specify multiple packages and/or versions for platforms that use Apt, Chocolatey, DNF, Homebrew, Pacman, or Zypper package managers. Specifying multiple packages and/or versions allows a single transaction to:\n\n * Download the specified packages and versions via a single HTTP transaction\n* Update or install multiple packages with a single resource during a Chef Infra Client run\n\n For example, installing multiple packages:\n\n \n```\npackage %w(package1 package2)\n\n```\n\nInstalling multiple packages with versions:\n\n \n```\npackage %w(package1 package2) do\n version [ '1.3.4-2', '4.3.6-1']\nend\n\n```\n\nUpgrading multiple packages:\n\n \n```\npackage %w(package1 package2) do\n action :upgrade\nend\n\n```\n\nRemoving multiple packages:\n\n \n```\npackage %w(package1 package2) do\n action :remove\nend\n\n```\n\nPurging multiple packages:\n\n \n```\npackage %w(package1 package2) do\n action :purge\nend\n\n```\n\nNotifications, via an implicit name:\n\n \n```\npackage %w(package1 package2) do\n action :nothing\nend\n\nlog 'call a notification' do\n notifies :install, 'package[package1, package2]', :immediately\nend\n\n```\n\n Note\n\n Notifications and subscriptions do not need to be updated when packages and versions are added or removed from the `package_name` or `version` properties.\n\n Examples\n--------\n\n \n\n---\n\n The following examples demonstrate various approaches for using the **dnf_package** resource in recipes:\n\n Install an exact version\n\n \n```\ndnf_package 'netpbm = 10.35.58-8.el5'\n\n```\n\nInstall a minimum version\n\n \n```\ndnf_package 'netpbm >= 10.35.58-8.el5'\n\n```\n\nInstall a minimum version using the default action\n\n \n```\ndnf_package 'netpbm'\n\n```\n\nTo install a package\n\n \n```\ndnf_package 'netpbm' do\n action :install\nend\n\n```\n\nTo install a partial minimum version\n\n \n```\ndnf_package 'netpbm >= 10'\n\n```\n\nTo install a specific architecture\n\n \n```\ndnf_package 'netpbm' do\n arch 'i386'\nend\n\n```\n\nor:\n\n \n```\ndnf_package 'netpbm.x86_64'\n\n```\n\nTo install a specific version-release\n\n \n```\ndnf_package 'netpbm' do\n version '10.35.58-8.el5'\nend\n\n```\n\nTo install a specific version (even when older than the current)\n\n \n```\ndnf_package 'tzdata' do\n version '2011b-1.el5'\nend\n\n```\n\nHandle cookbook_file and dnf_package resources in the same recipe\n\n When a **cookbook_file** resource and a **dnf_package** resource are both called from within the same recipe, use the `flush_cache` attribute to dump the in-memory DNF cache, and then use the repository immediately to ensure that the correct package is installed:\n\n \n```\ncookbook_file '/etc/yum.repos.d/custom.repo' do\n source 'custom'\n mode '0755'\nend\n\ndnf_package 'only-in-custom-repo' do\n action :install\n flush_cache [ :before ]\nend\n\n```\n \n\n © , Inc. \nLicensed under the Creative Commons Attribution 3.0 Unported License. \nThe Chef™ Mark and Chef Logo are either registered trademarks/service marks or trademarks/servicemarks of Chef, in the United States and other countries and are used with Chef Inc's permission. \nWe are not affiliated with, endorsed or sponsored by Chef Inc. \n\nThis is a placeholder for the home page.