Defined Type: xinetd::service

Defined in:
manifests/service.pp

Overview

Definition: xinetd::service

sets up a xinetd service all parameters match up with xinetd.conf(5) man page

Parameters:

$ensure                  - optional - defaults to 'present'
$log_on_success          - optional - may contain any combination of
                         'PID', 'HOST', 'USERID', 'EXIT', 'DURATION', 'TRAFFIC'
$log_on_success_operator - optional - defaults to '+='.  This is whether or
                           not values specified will be add, set or remove
                           from the default.
$log_on_failure          - optional - may contain any combination of
                          'HOST', 'USERID', 'ATTEMPT'
$log_on_failure_operator - optional - defaults to '+='.  This is whether or
                           not values specified will be add, set or remove
                           from the default.
$service_type            - optional - type setting in xinetd
                          may contain any combinarion of 'RPC', 'INTERNAL',
                          'TCPMUX/TCPMUXPLUS', 'UNLISTED'
$cps                     - optional
$flags                   - optional
$per_source              - optional
$port                    - optional - determines the service port (required if service is not listed in /etc/services)
$server                  - optional - determines the program to execute for this service
$server_args             - optional
$disable                 - optional - defaults to "no"
$socket_type             - optional - defaults to "stream"
$protocol                - optional - defaults to "tcp"
$user                    - optional - defaults to "root"
$group                   - optional - defaults to "root"
$use_default_group       - optional - defaults to true
$groups                  - optional - defaults to "yes"
$instances               - optional - defaults to "UNLIMITED"
$only_from               - optional
$wait                    - optional - based on $protocol will default to "yes" for udp and "no" for tcp
$xtype                   - deprecated - use $service_type instead
$no_access               - optional
$access_times            - optional
$log_type                - optional
$bind                    - optional
$nice                    - optional - integer between -20 and 19, inclusive.
$redirect                - optional - ip or hostname and port of the target service

Actions:

setups up a xinetd service by creating a file in /etc/xinetd.d/

Requires:

$server or $redirect must be set
$port must be set

Sample Usage:

# setup tftp service
xinetd::service { 'tftp':
  port        => '69',
  server      => '/usr/sbin/in.tftpd',
  server_args => '-s $base',
  socket_type => 'dgram',
  protocol    => 'udp',
  cps         => '100 2',
  flags       => 'IPv4',
  per_source  => '11',
  nice        => 19,
} # xinetd::service

Parameters:

  • server (Any) (defaults to: undef)
  • port (Any) (defaults to: undef)
  • ensure (Any) (defaults to: present)
  • log_on_success (Any) (defaults to: undef)
  • log_on_success_operator (Any) (defaults to: '+=')
  • log_on_failure (Any) (defaults to: undef)
  • log_on_failure_operator (Any) (defaults to: '+=')
  • service_type (Any) (defaults to: undef)
  • service_name (Any) (defaults to: $title)
  • cps (Any) (defaults to: undef)
  • disable (Any) (defaults to: 'no')
  • flags (Any) (defaults to: undef)
  • group (Any) (defaults to: undef)
  • use_default_group (Boolean) (defaults to: true)
  • groups (Any) (defaults to: 'yes')
  • instances (Any) (defaults to: 'UNLIMITED')
  • per_source (Any) (defaults to: undef)
  • protocol (Enum['tcp', 'udp']) (defaults to: 'tcp')
  • server_args (Any) (defaults to: undef)
  • socket_type (Any) (defaults to: 'stream')
  • user (Any) (defaults to: undef)
  • only_from (Any) (defaults to: undef)
  • wait (Any) (defaults to: undef)
  • xtype (Any) (defaults to: undef)
  • no_access (Any) (defaults to: undef)
  • access_times (Any) (defaults to: undef)
  • log_type (Any) (defaults to: undef)
  • bind (Any) (defaults to: undef)
  • nice (Optional[Integer[-20, 19]]) (defaults to: undef)
  • env (Any) (defaults to: undef)
  • passenv (Any) (defaults to: undef)
  • redirect (Any) (defaults to: undef) 


66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
 
# File 'manifests/service.pp', line 66

define xinetd::service (
  $server                           = undef,
  $port                             = undef,
  $ensure                           = present,
  $log_on_success                   = undef,
  $log_on_success_operator          = '+=',
  $log_on_failure                   = undef,
  $log_on_failure_operator          = '+=',
  $service_type                     = undef,
  $service_name                     = $title,
  $cps                              = undef,
  $disable                          = 'no',
  $flags                            = undef,
  $group                            = undef,
  Boolean $use_default_group        = true,
  $groups                           = 'yes',
  $instances                        = 'UNLIMITED',
  $per_source                       = undef,
  Enum['tcp', 'udp'] $protocol      = 'tcp',
  $server_args                      = undef,
  $socket_type                      = 'stream',
  $user                             = undef,
  $only_from                        = undef,
  $wait                             = undef,
  $xtype                            = undef,
  $no_access                        = undef,
  $access_times                     = undef,
  $log_type                         = undef,
  $bind                             = undef,
  Optional[Integer[-20, 19]] $nice  = undef,
  $env                              = undef,
  $passenv                          = undef,
  $redirect                         = undef,
) {

  include xinetd

  unless ($server or $redirect) {
    fail('xinetd::service needs either of server or redirect')
  }

  if $user {
    $_user = $user
  } else {
    $_user = $xinetd::params::default_user
  }

  if $group or !$use_default_group {
    $_group = $group
  } else {
    $_group = $xinetd::params::default_group
  }

  if $wait {
    $_wait = $wait
  } else {
    $_wait = $protocol ? {
      'tcp' => 'no',
      'udp' => 'yes'
    }
  }

  if $xtype {
    warning ('The $xtype parameter to xinetd::service is deprecated. Use the service_type parameter instead.')
  }

  # Template uses:
  # - $port
  # - $disable
  # - $socket_type
  # - $protocol
  # - $_wait
  # - $user
  # - $group
  # - $groups
  # - $server
  # - $bind
  # - $service_type
  # - $server_args
  # - $only_from
  # - $per_source
  # - $log_on_success
  # - $log_on_success_operator
  # - $log_on_failure
  # - $log_on_failure_operator
  # - $cps
  # - $flags
  # - $xtype (deprecated)
  # - $no_access
  # - $access_types
  # - $log_type
  # - $nice
  # - $env
  # - $passenv
  # - $redirect
  file { "${xinetd::confdir}/${title}":
    ensure  => $ensure,
    owner   => 'root',
    mode    => '0644',
    content => template('xinetd/service.erb'),
    notify  => Service[$xinetd::service_name],
    require => File[$xinetd::confdir],
  }

}