Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Fortios
  3. API Docs
  4. icap
  5. Server
Fortios v0.0.6 published on Tuesday, Jul 9, 2024 by pulumiverse
pulumiverse/pulumi-fortios

fortios.icap.Server

Explore with Pulumi AI

Fortios v0.0.6 published on Tuesday, Jul 9, 2024 by pulumiverse
pulumiverse/pulumi-fortios

Configure ICAP servers.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as fortios from "@pulumiverse/fortios";

const trname = new fortios.icap.Server("trname", {
    ip6Address: "::",
    ipAddress: "1.1.1.1",
    ipVersion: "4",
    maxConnections: 100,
    port: 22,
});
Copy
import pulumi
import pulumiverse_fortios as fortios

trname = fortios.icap.Server("trname",
    ip6_address="::",
    ip_address="1.1.1.1",
    ip_version="4",
    max_connections=100,
    port=22)
Copy
package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/pulumiverse/pulumi-fortios/sdk/go/fortios/icap"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := icap.NewServer(ctx, "trname", &icap.ServerArgs{
			Ip6Address:     pulumi.String("::"),
			IpAddress:      pulumi.String("1.1.1.1"),
			IpVersion:      pulumi.String("4"),
			MaxConnections: pulumi.Int(100),
			Port:           pulumi.Int(22),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Fortios = Pulumiverse.Fortios;

return await Deployment.RunAsync(() => 
{
    var trname = new Fortios.Icap.Server("trname", new()
    {
        Ip6Address = "::",
        IpAddress = "1.1.1.1",
        IpVersion = "4",
        MaxConnections = 100,
        Port = 22,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.fortios.icap.Server;
import com.pulumi.fortios.icap.ServerArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var trname = new Server("trname", ServerArgs.builder()
            .ip6Address("::")
            .ipAddress("1.1.1.1")
            .ipVersion("4")
            .maxConnections(100)
            .port(22)
            .build());

    }
}
Copy
resources:
  trname:
    type: fortios:icap:Server
    properties:
      ip6Address: '::'
      ipAddress: 1.1.1.1
      ipVersion: '4'
      maxConnections: 100
      port: 22
Copy

Create Server Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new Server(name: string, args?: ServerArgs, opts?: CustomResourceOptions);
@overload
def Server(resource_name: str,
           args: Optional[ServerArgs] = None,
           opts: Optional[ResourceOptions] = None)

@overload
def Server(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           addr_type: Optional[str] = None,
           fqdn: Optional[str] = None,
           healthcheck: Optional[str] = None,
           healthcheck_service: Optional[str] = None,
           ip6_address: Optional[str] = None,
           ip_address: Optional[str] = None,
           ip_version: Optional[str] = None,
           max_connections: Optional[int] = None,
           name: Optional[str] = None,
           port: Optional[int] = None,
           secure: Optional[str] = None,
           ssl_cert: Optional[str] = None,
           vdomparam: Optional[str] = None)
func NewServer(ctx *Context, name string, args *ServerArgs, opts ...ResourceOption) (*Server, error)
public Server(string name, ServerArgs? args = null, CustomResourceOptions? opts = null)
public Server(String name, ServerArgs args)
public Server(String name, ServerArgs args, CustomResourceOptions options)

type: fortios:icap:Server
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args ServerArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args ServerArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args ServerArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args ServerArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. ServerArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var serverResource = new Fortios.Icap.Server("serverResource", new()
{
    AddrType = "string",
    Fqdn = "string",
    Healthcheck = "string",
    HealthcheckService = "string",
    Ip6Address = "string",
    IpAddress = "string",
    IpVersion = "string",
    MaxConnections = 0,
    Name = "string",
    Port = 0,
    Secure = "string",
    SslCert = "string",
    Vdomparam = "string",
});
Copy
example, err := icap.NewServer(ctx, "serverResource", &icap.ServerArgs{
	AddrType:           pulumi.String("string"),
	Fqdn:               pulumi.String("string"),
	Healthcheck:        pulumi.String("string"),
	HealthcheckService: pulumi.String("string"),
	Ip6Address:         pulumi.String("string"),
	IpAddress:          pulumi.String("string"),
	IpVersion:          pulumi.String("string"),
	MaxConnections:     pulumi.Int(0),
	Name:               pulumi.String("string"),
	Port:               pulumi.Int(0),
	Secure:             pulumi.String("string"),
	SslCert:            pulumi.String("string"),
	Vdomparam:          pulumi.String("string"),
})
Copy
var serverResource = new Server("serverResource", ServerArgs.builder()
    .addrType("string")
    .fqdn("string")
    .healthcheck("string")
    .healthcheckService("string")
    .ip6Address("string")
    .ipAddress("string")
    .ipVersion("string")
    .maxConnections(0)
    .name("string")
    .port(0)
    .secure("string")
    .sslCert("string")
    .vdomparam("string")
    .build());
Copy
server_resource = fortios.icap.Server("serverResource",
    addr_type="string",
    fqdn="string",
    healthcheck="string",
    healthcheck_service="string",
    ip6_address="string",
    ip_address="string",
    ip_version="string",
    max_connections=0,
    name="string",
    port=0,
    secure="string",
    ssl_cert="string",
    vdomparam="string")
Copy
const serverResource = new fortios.icap.Server("serverResource", {
    addrType: "string",
    fqdn: "string",
    healthcheck: "string",
    healthcheckService: "string",
    ip6Address: "string",
    ipAddress: "string",
    ipVersion: "string",
    maxConnections: 0,
    name: "string",
    port: 0,
    secure: "string",
    sslCert: "string",
    vdomparam: "string",
});
Copy
type: fortios:icap:Server
properties:
    addrType: string
    fqdn: string
    healthcheck: string
    healthcheckService: string
    ip6Address: string
    ipAddress: string
    ipVersion: string
    maxConnections: 0
    name: string
    port: 0
    secure: string
    sslCert: string
    vdomparam: string
Copy

Server Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Server resource accepts the following input properties:

AddrType string
Address type of the remote ICAP server: IPv4, IPv6 or FQDN. Valid values: ip4, ip6, fqdn.
Fqdn string
ICAP remote server Fully Qualified Domain Name (FQDN).
Healthcheck string
Enable/disable ICAP remote server health checking. Attempts to connect to the remote ICAP server to verify that the server is operating normally. Valid values: disable, enable.
HealthcheckService string
ICAP Service name to use for health checks.
Ip6Address string
IPv6 address of the ICAP server.
IpAddress string
IPv4 address of the ICAP server.
IpVersion string
IP version. Valid values: 4, 6.
MaxConnections int
Maximum number of concurrent connections to ICAP server. Must not be less than wad-worker-count.
Name Changes to this property will trigger replacement. string
Server name.
Port int
ICAP server port.
Secure string
Enable/disable secure connection to ICAP server. Valid values: enable, disable.
SslCert string
CA certificate name.
Vdomparam Changes to this property will trigger replacement. string
Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
AddrType string
Address type of the remote ICAP server: IPv4, IPv6 or FQDN. Valid values: ip4, ip6, fqdn.
Fqdn string
ICAP remote server Fully Qualified Domain Name (FQDN).
Healthcheck string
Enable/disable ICAP remote server health checking. Attempts to connect to the remote ICAP server to verify that the server is operating normally. Valid values: disable, enable.
HealthcheckService string
ICAP Service name to use for health checks.
Ip6Address string
IPv6 address of the ICAP server.
IpAddress string
IPv4 address of the ICAP server.
IpVersion string
IP version. Valid values: 4, 6.
MaxConnections int
Maximum number of concurrent connections to ICAP server. Must not be less than wad-worker-count.
Name Changes to this property will trigger replacement. string
Server name.
Port int
ICAP server port.
Secure string
Enable/disable secure connection to ICAP server. Valid values: enable, disable.
SslCert string
CA certificate name.
Vdomparam Changes to this property will trigger replacement. string
Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
addrType String
Address type of the remote ICAP server: IPv4, IPv6 or FQDN. Valid values: ip4, ip6, fqdn.
fqdn String
ICAP remote server Fully Qualified Domain Name (FQDN).
healthcheck String
Enable/disable ICAP remote server health checking. Attempts to connect to the remote ICAP server to verify that the server is operating normally. Valid values: disable, enable.
healthcheckService String
ICAP Service name to use for health checks.
ip6Address String
IPv6 address of the ICAP server.
ipAddress String
IPv4 address of the ICAP server.
ipVersion String
IP version. Valid values: 4, 6.
maxConnections Integer
Maximum number of concurrent connections to ICAP server. Must not be less than wad-worker-count.
name Changes to this property will trigger replacement. String
Server name.
port Integer
ICAP server port.
secure String
Enable/disable secure connection to ICAP server. Valid values: enable, disable.
sslCert String
CA certificate name.
vdomparam Changes to this property will trigger replacement. String
Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
addrType string
Address type of the remote ICAP server: IPv4, IPv6 or FQDN. Valid values: ip4, ip6, fqdn.
fqdn string
ICAP remote server Fully Qualified Domain Name (FQDN).
healthcheck string
Enable/disable ICAP remote server health checking. Attempts to connect to the remote ICAP server to verify that the server is operating normally. Valid values: disable, enable.
healthcheckService string
ICAP Service name to use for health checks.
ip6Address string
IPv6 address of the ICAP server.
ipAddress string
IPv4 address of the ICAP server.
ipVersion string
IP version. Valid values: 4, 6.
maxConnections number
Maximum number of concurrent connections to ICAP server. Must not be less than wad-worker-count.
name Changes to this property will trigger replacement. string
Server name.
port number
ICAP server port.
secure string
Enable/disable secure connection to ICAP server. Valid values: enable, disable.
sslCert string
CA certificate name.
vdomparam Changes to this property will trigger replacement. string
Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
addr_type str
Address type of the remote ICAP server: IPv4, IPv6 or FQDN. Valid values: ip4, ip6, fqdn.
fqdn str
ICAP remote server Fully Qualified Domain Name (FQDN).
healthcheck str
Enable/disable ICAP remote server health checking. Attempts to connect to the remote ICAP server to verify that the server is operating normally. Valid values: disable, enable.
healthcheck_service str
ICAP Service name to use for health checks.
ip6_address str
IPv6 address of the ICAP server.
ip_address str
IPv4 address of the ICAP server.
ip_version str
IP version. Valid values: 4, 6.
max_connections int
Maximum number of concurrent connections to ICAP server. Must not be less than wad-worker-count.
name Changes to this property will trigger replacement. str
Server name.
port int
ICAP server port.
secure str
Enable/disable secure connection to ICAP server. Valid values: enable, disable.
ssl_cert str
CA certificate name.
vdomparam Changes to this property will trigger replacement. str
Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
addrType String
Address type of the remote ICAP server: IPv4, IPv6 or FQDN. Valid values: ip4, ip6, fqdn.
fqdn String
ICAP remote server Fully Qualified Domain Name (FQDN).
healthcheck String
Enable/disable ICAP remote server health checking. Attempts to connect to the remote ICAP server to verify that the server is operating normally. Valid values: disable, enable.
healthcheckService String
ICAP Service name to use for health checks.
ip6Address String
IPv6 address of the ICAP server.
ipAddress String
IPv4 address of the ICAP server.
ipVersion String
IP version. Valid values: 4, 6.
maxConnections Number
Maximum number of concurrent connections to ICAP server. Must not be less than wad-worker-count.
name Changes to this property will trigger replacement. String
Server name.
port Number
ICAP server port.
secure String
Enable/disable secure connection to ICAP server. Valid values: enable, disable.
sslCert String
CA certificate name.
vdomparam Changes to this property will trigger replacement. String
Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.

Outputs

All input properties are implicitly available as output properties. Additionally, the Server resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing Server Resource

Get an existing Server resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: ServerState, opts?: CustomResourceOptions): Server
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        addr_type: Optional[str] = None,
        fqdn: Optional[str] = None,
        healthcheck: Optional[str] = None,
        healthcheck_service: Optional[str] = None,
        ip6_address: Optional[str] = None,
        ip_address: Optional[str] = None,
        ip_version: Optional[str] = None,
        max_connections: Optional[int] = None,
        name: Optional[str] = None,
        port: Optional[int] = None,
        secure: Optional[str] = None,
        ssl_cert: Optional[str] = None,
        vdomparam: Optional[str] = None) -> Server
func GetServer(ctx *Context, name string, id IDInput, state *ServerState, opts ...ResourceOption) (*Server, error)
public static Server Get(string name, Input<string> id, ServerState? state, CustomResourceOptions? opts = null)
public static Server get(String name, Output<String> id, ServerState state, CustomResourceOptions options)
resources:  _:    type: fortios:icap:Server    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
AddrType string
Address type of the remote ICAP server: IPv4, IPv6 or FQDN. Valid values: ip4, ip6, fqdn.
Fqdn string
ICAP remote server Fully Qualified Domain Name (FQDN).
Healthcheck string
Enable/disable ICAP remote server health checking. Attempts to connect to the remote ICAP server to verify that the server is operating normally. Valid values: disable, enable.
HealthcheckService string
ICAP Service name to use for health checks.
Ip6Address string
IPv6 address of the ICAP server.
IpAddress string
IPv4 address of the ICAP server.
IpVersion string
IP version. Valid values: 4, 6.
MaxConnections int
Maximum number of concurrent connections to ICAP server. Must not be less than wad-worker-count.
Name Changes to this property will trigger replacement. string
Server name.
Port int
ICAP server port.
Secure string
Enable/disable secure connection to ICAP server. Valid values: enable, disable.
SslCert string
CA certificate name.
Vdomparam Changes to this property will trigger replacement. string
Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
AddrType string
Address type of the remote ICAP server: IPv4, IPv6 or FQDN. Valid values: ip4, ip6, fqdn.
Fqdn string
ICAP remote server Fully Qualified Domain Name (FQDN).
Healthcheck string
Enable/disable ICAP remote server health checking. Attempts to connect to the remote ICAP server to verify that the server is operating normally. Valid values: disable, enable.
HealthcheckService string
ICAP Service name to use for health checks.
Ip6Address string
IPv6 address of the ICAP server.
IpAddress string
IPv4 address of the ICAP server.
IpVersion string
IP version. Valid values: 4, 6.
MaxConnections int
Maximum number of concurrent connections to ICAP server. Must not be less than wad-worker-count.
Name Changes to this property will trigger replacement. string
Server name.
Port int
ICAP server port.
Secure string
Enable/disable secure connection to ICAP server. Valid values: enable, disable.
SslCert string
CA certificate name.
Vdomparam Changes to this property will trigger replacement. string
Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
addrType String
Address type of the remote ICAP server: IPv4, IPv6 or FQDN. Valid values: ip4, ip6, fqdn.
fqdn String
ICAP remote server Fully Qualified Domain Name (FQDN).
healthcheck String
Enable/disable ICAP remote server health checking. Attempts to connect to the remote ICAP server to verify that the server is operating normally. Valid values: disable, enable.
healthcheckService String
ICAP Service name to use for health checks.
ip6Address String
IPv6 address of the ICAP server.
ipAddress String
IPv4 address of the ICAP server.
ipVersion String
IP version. Valid values: 4, 6.
maxConnections Integer
Maximum number of concurrent connections to ICAP server. Must not be less than wad-worker-count.
name Changes to this property will trigger replacement. String
Server name.
port Integer
ICAP server port.
secure String
Enable/disable secure connection to ICAP server. Valid values: enable, disable.
sslCert String
CA certificate name.
vdomparam Changes to this property will trigger replacement. String
Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
addrType string
Address type of the remote ICAP server: IPv4, IPv6 or FQDN. Valid values: ip4, ip6, fqdn.
fqdn string
ICAP remote server Fully Qualified Domain Name (FQDN).
healthcheck string
Enable/disable ICAP remote server health checking. Attempts to connect to the remote ICAP server to verify that the server is operating normally. Valid values: disable, enable.
healthcheckService string
ICAP Service name to use for health checks.
ip6Address string
IPv6 address of the ICAP server.
ipAddress string
IPv4 address of the ICAP server.
ipVersion string
IP version. Valid values: 4, 6.
maxConnections number
Maximum number of concurrent connections to ICAP server. Must not be less than wad-worker-count.
name Changes to this property will trigger replacement. string
Server name.
port number
ICAP server port.
secure string
Enable/disable secure connection to ICAP server. Valid values: enable, disable.
sslCert string
CA certificate name.
vdomparam Changes to this property will trigger replacement. string
Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
addr_type str
Address type of the remote ICAP server: IPv4, IPv6 or FQDN. Valid values: ip4, ip6, fqdn.
fqdn str
ICAP remote server Fully Qualified Domain Name (FQDN).
healthcheck str
Enable/disable ICAP remote server health checking. Attempts to connect to the remote ICAP server to verify that the server is operating normally. Valid values: disable, enable.
healthcheck_service str
ICAP Service name to use for health checks.
ip6_address str
IPv6 address of the ICAP server.
ip_address str
IPv4 address of the ICAP server.
ip_version str
IP version. Valid values: 4, 6.
max_connections int
Maximum number of concurrent connections to ICAP server. Must not be less than wad-worker-count.
name Changes to this property will trigger replacement. str
Server name.
port int
ICAP server port.
secure str
Enable/disable secure connection to ICAP server. Valid values: enable, disable.
ssl_cert str
CA certificate name.
vdomparam Changes to this property will trigger replacement. str
Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
addrType String
Address type of the remote ICAP server: IPv4, IPv6 or FQDN. Valid values: ip4, ip6, fqdn.
fqdn String
ICAP remote server Fully Qualified Domain Name (FQDN).
healthcheck String
Enable/disable ICAP remote server health checking. Attempts to connect to the remote ICAP server to verify that the server is operating normally. Valid values: disable, enable.
healthcheckService String
ICAP Service name to use for health checks.
ip6Address String
IPv6 address of the ICAP server.
ipAddress String
IPv4 address of the ICAP server.
ipVersion String
IP version. Valid values: 4, 6.
maxConnections Number
Maximum number of concurrent connections to ICAP server. Must not be less than wad-worker-count.
name Changes to this property will trigger replacement. String
Server name.
port Number
ICAP server port.
secure String
Enable/disable secure connection to ICAP server. Valid values: enable, disable.
sslCert String
CA certificate name.
vdomparam Changes to this property will trigger replacement. String
Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.

Import

Icap Server can be imported using any of these accepted formats:

$ pulumi import fortios:icap/server:Server labelname {{name}}
Copy

If you do not want to import arguments of block:

$ export “FORTIOS_IMPORT_TABLE”=“false”

$ pulumi import fortios:icap/server:Server labelname {{name}}
Copy

$ unset “FORTIOS_IMPORT_TABLE”

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
fortios pulumiverse/pulumi-fortios
License
Apache-2.0
Notes
This Pulumi package is based on the fortios Terraform Provider.
Fortios v0.0.6 published on Tuesday, Jul 9, 2024 by pulumiverse
pulumiverse/pulumi-fortios