1. Packages
  2. Fortios
  3. API Docs
  4. dpdk
  5. Cpus
Fortios v0.0.5 published on Tuesday, Apr 9, 2024 by pulumiverse

fortios.dpdk.Cpus

Explore with Pulumi AI

fortios logo
Fortios v0.0.5 published on Tuesday, Apr 9, 2024 by pulumiverse

    Configure CPUs enabled to run engines in each DPDK stage. Applies to FortiOS Version >= 6.2.4.

    Create Cpus Resource

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

    Constructor syntax

    new Cpus(name: string, args?: CpusArgs, opts?: CustomResourceOptions);
    @overload
    def Cpus(resource_name: str,
             args: Optional[CpusArgs] = None,
             opts: Optional[ResourceOptions] = None)
    
    @overload
    def Cpus(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             ips_cpus: Optional[str] = None,
             isolated_cpus: Optional[str] = None,
             rx_cpus: Optional[str] = None,
             tx_cpus: Optional[str] = None,
             vdomparam: Optional[str] = None,
             vnp_cpus: Optional[str] = None,
             vnpsp_cpus: Optional[str] = None)
    func NewCpus(ctx *Context, name string, args *CpusArgs, opts ...ResourceOption) (*Cpus, error)
    public Cpus(string name, CpusArgs? args = null, CustomResourceOptions? opts = null)
    public Cpus(String name, CpusArgs args)
    public Cpus(String name, CpusArgs args, CustomResourceOptions options)
    
    type: fortios:dpdk:Cpus
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

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

    Example

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

    var cpusResource = new Fortios.Dpdk.Cpus("cpusResource", new()
    {
        IpsCpus = "string",
        IsolatedCpus = "string",
        RxCpus = "string",
        TxCpus = "string",
        Vdomparam = "string",
        VnpCpus = "string",
        VnpspCpus = "string",
    });
    
    example, err := dpdk.NewCpus(ctx, "cpusResource", &dpdk.CpusArgs{
    	IpsCpus:      pulumi.String("string"),
    	IsolatedCpus: pulumi.String("string"),
    	RxCpus:       pulumi.String("string"),
    	TxCpus:       pulumi.String("string"),
    	Vdomparam:    pulumi.String("string"),
    	VnpCpus:      pulumi.String("string"),
    	VnpspCpus:    pulumi.String("string"),
    })
    
    var cpusResource = new Cpus("cpusResource", CpusArgs.builder()        
        .ipsCpus("string")
        .isolatedCpus("string")
        .rxCpus("string")
        .txCpus("string")
        .vdomparam("string")
        .vnpCpus("string")
        .vnpspCpus("string")
        .build());
    
    cpus_resource = fortios.dpdk.Cpus("cpusResource",
        ips_cpus="string",
        isolated_cpus="string",
        rx_cpus="string",
        tx_cpus="string",
        vdomparam="string",
        vnp_cpus="string",
        vnpsp_cpus="string")
    
    const cpusResource = new fortios.dpdk.Cpus("cpusResource", {
        ipsCpus: "string",
        isolatedCpus: "string",
        rxCpus: "string",
        txCpus: "string",
        vdomparam: "string",
        vnpCpus: "string",
        vnpspCpus: "string",
    });
    
    type: fortios:dpdk:Cpus
    properties:
        ipsCpus: string
        isolatedCpus: string
        rxCpus: string
        txCpus: string
        vdomparam: string
        vnpCpus: string
        vnpspCpus: string
    

    Cpus Resource Properties

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

    Inputs

    The Cpus resource accepts the following input properties:

    IpsCpus string
    CPUs enabled to run DPDK IPS engines.
    IsolatedCpus string
    CPUs isolated to run only the DPDK engines with the exception of processes that have affinity explicitly set by either a user configuration or by their implementation.
    RxCpus string
    CPUs enabled to run DPDK RX engines.
    TxCpus string
    CPUs enabled to run DPDK TX engines.
    Vdomparam 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.
    VnpCpus string
    CPUs enabled to run DPDK VNP engines.
    VnpspCpus string
    CPUs enabled to run DPDK VNP slow path.
    IpsCpus string
    CPUs enabled to run DPDK IPS engines.
    IsolatedCpus string
    CPUs isolated to run only the DPDK engines with the exception of processes that have affinity explicitly set by either a user configuration or by their implementation.
    RxCpus string
    CPUs enabled to run DPDK RX engines.
    TxCpus string
    CPUs enabled to run DPDK TX engines.
    Vdomparam 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.
    VnpCpus string
    CPUs enabled to run DPDK VNP engines.
    VnpspCpus string
    CPUs enabled to run DPDK VNP slow path.
    ipsCpus String
    CPUs enabled to run DPDK IPS engines.
    isolatedCpus String
    CPUs isolated to run only the DPDK engines with the exception of processes that have affinity explicitly set by either a user configuration or by their implementation.
    rxCpus String
    CPUs enabled to run DPDK RX engines.
    txCpus String
    CPUs enabled to run DPDK TX engines.
    vdomparam 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.
    vnpCpus String
    CPUs enabled to run DPDK VNP engines.
    vnpspCpus String
    CPUs enabled to run DPDK VNP slow path.
    ipsCpus string
    CPUs enabled to run DPDK IPS engines.
    isolatedCpus string
    CPUs isolated to run only the DPDK engines with the exception of processes that have affinity explicitly set by either a user configuration or by their implementation.
    rxCpus string
    CPUs enabled to run DPDK RX engines.
    txCpus string
    CPUs enabled to run DPDK TX engines.
    vdomparam 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.
    vnpCpus string
    CPUs enabled to run DPDK VNP engines.
    vnpspCpus string
    CPUs enabled to run DPDK VNP slow path.
    ips_cpus str
    CPUs enabled to run DPDK IPS engines.
    isolated_cpus str
    CPUs isolated to run only the DPDK engines with the exception of processes that have affinity explicitly set by either a user configuration or by their implementation.
    rx_cpus str
    CPUs enabled to run DPDK RX engines.
    tx_cpus str
    CPUs enabled to run DPDK TX engines.
    vdomparam 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.
    vnp_cpus str
    CPUs enabled to run DPDK VNP engines.
    vnpsp_cpus str
    CPUs enabled to run DPDK VNP slow path.
    ipsCpus String
    CPUs enabled to run DPDK IPS engines.
    isolatedCpus String
    CPUs isolated to run only the DPDK engines with the exception of processes that have affinity explicitly set by either a user configuration or by their implementation.
    rxCpus String
    CPUs enabled to run DPDK RX engines.
    txCpus String
    CPUs enabled to run DPDK TX engines.
    vdomparam 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.
    vnpCpus String
    CPUs enabled to run DPDK VNP engines.
    vnpspCpus String
    CPUs enabled to run DPDK VNP slow path.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Cpus 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 Cpus Resource

    Get an existing Cpus 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?: CpusState, opts?: CustomResourceOptions): Cpus
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            ips_cpus: Optional[str] = None,
            isolated_cpus: Optional[str] = None,
            rx_cpus: Optional[str] = None,
            tx_cpus: Optional[str] = None,
            vdomparam: Optional[str] = None,
            vnp_cpus: Optional[str] = None,
            vnpsp_cpus: Optional[str] = None) -> Cpus
    func GetCpus(ctx *Context, name string, id IDInput, state *CpusState, opts ...ResourceOption) (*Cpus, error)
    public static Cpus Get(string name, Input<string> id, CpusState? state, CustomResourceOptions? opts = null)
    public static Cpus get(String name, Output<String> id, CpusState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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:
    IpsCpus string
    CPUs enabled to run DPDK IPS engines.
    IsolatedCpus string
    CPUs isolated to run only the DPDK engines with the exception of processes that have affinity explicitly set by either a user configuration or by their implementation.
    RxCpus string
    CPUs enabled to run DPDK RX engines.
    TxCpus string
    CPUs enabled to run DPDK TX engines.
    Vdomparam 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.
    VnpCpus string
    CPUs enabled to run DPDK VNP engines.
    VnpspCpus string
    CPUs enabled to run DPDK VNP slow path.
    IpsCpus string
    CPUs enabled to run DPDK IPS engines.
    IsolatedCpus string
    CPUs isolated to run only the DPDK engines with the exception of processes that have affinity explicitly set by either a user configuration or by their implementation.
    RxCpus string
    CPUs enabled to run DPDK RX engines.
    TxCpus string
    CPUs enabled to run DPDK TX engines.
    Vdomparam 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.
    VnpCpus string
    CPUs enabled to run DPDK VNP engines.
    VnpspCpus string
    CPUs enabled to run DPDK VNP slow path.
    ipsCpus String
    CPUs enabled to run DPDK IPS engines.
    isolatedCpus String
    CPUs isolated to run only the DPDK engines with the exception of processes that have affinity explicitly set by either a user configuration or by their implementation.
    rxCpus String
    CPUs enabled to run DPDK RX engines.
    txCpus String
    CPUs enabled to run DPDK TX engines.
    vdomparam 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.
    vnpCpus String
    CPUs enabled to run DPDK VNP engines.
    vnpspCpus String
    CPUs enabled to run DPDK VNP slow path.
    ipsCpus string
    CPUs enabled to run DPDK IPS engines.
    isolatedCpus string
    CPUs isolated to run only the DPDK engines with the exception of processes that have affinity explicitly set by either a user configuration or by their implementation.
    rxCpus string
    CPUs enabled to run DPDK RX engines.
    txCpus string
    CPUs enabled to run DPDK TX engines.
    vdomparam 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.
    vnpCpus string
    CPUs enabled to run DPDK VNP engines.
    vnpspCpus string
    CPUs enabled to run DPDK VNP slow path.
    ips_cpus str
    CPUs enabled to run DPDK IPS engines.
    isolated_cpus str
    CPUs isolated to run only the DPDK engines with the exception of processes that have affinity explicitly set by either a user configuration or by their implementation.
    rx_cpus str
    CPUs enabled to run DPDK RX engines.
    tx_cpus str
    CPUs enabled to run DPDK TX engines.
    vdomparam 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.
    vnp_cpus str
    CPUs enabled to run DPDK VNP engines.
    vnpsp_cpus str
    CPUs enabled to run DPDK VNP slow path.
    ipsCpus String
    CPUs enabled to run DPDK IPS engines.
    isolatedCpus String
    CPUs isolated to run only the DPDK engines with the exception of processes that have affinity explicitly set by either a user configuration or by their implementation.
    rxCpus String
    CPUs enabled to run DPDK RX engines.
    txCpus String
    CPUs enabled to run DPDK TX engines.
    vdomparam 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.
    vnpCpus String
    CPUs enabled to run DPDK VNP engines.
    vnpspCpus String
    CPUs enabled to run DPDK VNP slow path.

    Import

    Dpdk Cpus can be imported using any of these accepted formats:

    $ pulumi import fortios:dpdk/cpus:Cpus labelname DpdkCpus
    

    If you do not want to import arguments of block:

    $ export “FORTIOS_IMPORT_TABLE”=“false”

    $ pulumi import fortios:dpdk/cpus:Cpus labelname DpdkCpus
    

    $ 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 logo
    Fortios v0.0.5 published on Tuesday, Apr 9, 2024 by pulumiverse