Resource Type: netscaler_service

Defined in:

lib/puppet/type/netscaler_service.rb

Providers:

rest

Overview

Manage service on the NetScaler appliance. If the service is domain based, before you create the service, create the server entry by using the add server command. Then, in this command, specify the Server parameter.

Properties

• access_down
• appflow_logging
• cache_type

  Cache type supported by the cache server.

• cacheable
• clear_text_port

  Port to which clear text data must be sent after the appliance decrypts incoming SSL traffic. Applicable to transparent SSL services.

• client_idle_timeout

  Time, in seconds, after which to terminate an idle client connection.

  Max = 31536000

• client_ip
• client_ip_header

  Name for the HTTP header whose value must be set to the IP address of the client. Used with the Client IP parameter. If you set the Client IP parameter, and you do not specify a name for the header, the appliance uses the header name specified for the global Client IP Header parameter (the cipHeader parameter in the set ns param CLI command or the Client IP Header parameter in the Configure HTTP Parameters dialog box at System > Settings > Change HTTP parameters). If the global Client IP Header parameter is not specified, the appliance inserts a header with the name "client-ip."

• client_keepalive
• comments

  Any information about the object.

• down_state_flush
• ensure (defaults to: present)

  The basic property that the resource should be in.

  Supported values:

  • present
  • absent
• hash_id

  A numerical identifier that can be used by hash based load balancing methods. Must be unique for each service.

  Minimum value: 1

• health_monitoring
• max_bandwidth

  Maximum bandwidth, in Kbps, allocated to the service.

  Max = 4294967287

• max_clients

  Maximum number of simultaneous open connections to the service.

  Max = 4294967294

• max_requests

  Maximum number of requests that can be sent on a persistent connection to the service. Note: Connection requests beyond this value are rejected.

  Max = 65535

• monitor_threshold

  Minimum sum of weights of the monitors that are bound to this service. Used to determine whether to mark a service as UP or DOWN.

  Max = 65535

• net_profile_name

  Network profile to use for the service.

• port

  Port number of the service. Required.

• protocol

  Protocol in which data is exchanged with the service. Required.

• server_id

  Unique identifier for the service. Used when the persistency type for the virtual server is set to Custom Server ID.

• server_idle_timeout

  Time, in seconds, after which to terminate an idle server connection.

  Max = 31536000

• server_name

  Name of the server that hosts the service. Required.

• state
• sure_connect
• surge_protection
• tcp_buffering
• traffic_domain_id
• use_proxy_port
• use_source_ip

Parameters

• graceful_shutdown
• name (namevar)
• provider

  The specific backend to use for this ‘netscaler_service` resource. You will seldom need to specify this — Puppet will usually discover the appropriate provider for your platform.