Use the route resource to manage the system routing table in a Linux environment.
A route resource block manages the system routing table in a Linux environment:
route '10.0.1.10/32' do gateway '10.0.0.20' device 'eth1' end
The full syntax for all of the properties that are available to the route resource is:
route 'name' do device String gateway String netmask String notifies # see description provider Chef::Provider::Route subscribes # see description target String # defaults to 'name' if not specified action Symbol # defaults to :add if not specified end
where
route
is the resourcename
is the name of the resource block:action
identifies the steps the chef-client will take to bring the node into the desired statedevice
, gateway
, netmask
, provider
and target
are properties of this resource, with the Ruby type shown. See “Properties” section below for more information about all of the properties that may be used with this resource.This resource has the following actions:
:add
:delete
:nothing
This resource has the following properties:
device
Ruby Type: String
The network interface to which the route applies.
gateway
Ruby Type: String
The gateway for the route.
ignore_failure
Ruby Types: TrueClass, FalseClass
Continue running a recipe if a resource fails for any reason. Default value: false
.
netmask
Ruby Type: String
The decimal representation of the network mask. For example: 255.255.255.0
.
notifies
Ruby Type: Symbol, ‘Chef::Resource[String]’
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 notifiy more than one resource; use a notifies
statement for each resource to be notified.
A timer specifies the point during the chef-client run at which a notification is run. The following timers are available:
:before
:delayed
:immediate
, :immediately
The syntax for notifies
is:
notifies :action, 'resource[name]', :timer
provider
Ruby Type: Chef Class
Optional. Explicitly specifies a provider.
retries
Ruby Type: Integer
The number of times to catch exceptions and retry the resource. Default value: 0
.
retry_delay
Ruby Type: Integer
The retry delay (in seconds). Default value: 2
.
subscribes
Ruby Type: Symbol, ‘Chef::Resource[String]’
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.
A timer specifies the point during the chef-client run at which a notification is run. The following timers are available:
:before
:delayed
:immediate
, :immediately
The syntax for subscribes
is:
subscribes :action, 'resource[name]', :timer
target
Ruby Type: String
The IP address of the target route. Default value: the name
of the resource block See “Syntax” section above for more information.
The following examples demonstrate various approaches for using resources in recipes. If you want to see examples of how Chef uses resources in recipes, take a closer look at the cookbooks that Chef authors and maintains: https://github.com/chef-cookbooks.
Add a host route
route '10.0.1.10/32' do gateway '10.0.0.20' device 'eth1' end
Delete a network route
route '10.1.1.0/24' do gateway '10.0.0.20' action :delete end
© Chef Software, Inc.
Licensed under the Creative Commons Attribution 3.0 Unported License.
The 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.
We are not affiliated with, endorsed or sponsored by Chef Inc.
https://docs-archive.chef.io/release/12-13/resource_route.html