Skip to content

Commit

Permalink
oapi-cli v0.5.0
Browse files Browse the repository at this point in the history
Signed-off-by: Outscale Bot <[email protected]>
  • Loading branch information
Open-Source-Bot authored and outscale-mgo committed Jul 29, 2024
1 parent 8481f3c commit 53e47ac
Show file tree
Hide file tree
Showing 5 changed files with 110 additions and 101 deletions.
2 changes: 1 addition & 1 deletion main.c
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@

#define OAPI_RAW_OUTPUT 1

#define OAPI_CLI_VERSION "0.4.0"
#define OAPI_CLI_VERSION "0.5.0"

#define OAPI_CLI_UAGENT "oapi-cli/"OAPI_CLI_VERSION"; osc-sdk-c/"

Expand Down
2 changes: 1 addition & 1 deletion osc-sdk-C
Submodule osc-sdk-C updated 3 files
+26 −24 osc_sdk.c
+81 −74 osc_sdk.h
+1 −1 sdk_version
50 changes: 26 additions & 24 deletions osc_sdk.c
Original file line number Diff line number Diff line change
Expand Up @@ -670,9 +670,9 @@ static const char *calls_descriptions[] = {
,
"Usage: oapi-cli CreateSubnet --IpRange=iprange --NetId=netid [OPTIONS]\n" "Creates a Subnet in an existing Net.\nTo create a Subnet in a Net, you have to \n" "provide the ID of the Net and the IP range for the Subnet (its network range). \n" "Once the Subnet is created, you cannot modify its IP range.\nFor more \n" "information, see [About \n" "Nets](https://docs.outscale.com/en/userguide/About-Nets.html).\n" "\nRequired Argument: IpRange, NetId \n"
,
"Usage: oapi-cli CreateSnapshotExportTask --OsuExport=osuexport --SnapshotId=snapshotid [OPTIONS]\n" "Exports a snapshot to an OUTSCALE Object Storage (OOS) bucket.\nThis action \n" "enables you to create a backup of your snapshot or to copy it to another \n" "account. You, or other accounts you send a pre-signed URL to, can then download \n" "this snapshot from the bucket using the [CreateSnapshot](#createsnapshot) \n" "method.\nThis procedure enables you to copy a snapshot between accounts within \n" "the same Region or in different Regions. To copy a snapshot within the same \n" "Region, you can also use the [CreateSnapshot](#createsnapshot) direct method. \n" "The copy of the source snapshot is independent and belongs to you.\nFor more \n" "information, see [About \n" "Snapshots](https://docs.outscale.com/en/userguide/About-Snapshots.html).\n" "\nRequired Argument: OsuExport, SnapshotId \n"
"Usage: oapi-cli CreateSnapshotExportTask --OsuExport=osuexport --SnapshotId=snapshotid [OPTIONS]\n" "Exports a snapshot to an OUTSCALE Object Storage (OOS) bucket that belongs to \n" "you. This action enables you to create a backup of your snapshot.\nYou can \n" "share this snapshot with others accounts by granting permission to read it via \n" "pre-signed URLs or Access Control Lists (ACLs). For more information, see \n" "[Managing Access to Your Buckets and \n" "Objects](https://docs.outscale.com/en/userguide/Managing-Access-to-Your-Buckets-\n" "and-Objects.html).\nFor more information, see [About \n" "Snapshots](https://docs.outscale.com/en/userguide/About-Snapshots.html).\n" "\nRequired Argument: OsuExport, SnapshotId \n"
,
"Usage: oapi-cli CreateSnapshot [OPTIONS]\n" "Creates a snapshot. Snapshots are point-in-time images of a volume that you can \n" "use to back up your data or to create replicas of this volume.\nYou can use \n" "this method in three different ways:\n* **Creating from a volume**: You create \n" "a snapshot from one of your volumes.\n* **Copying a snapshot**: You copy an \n" "existing snapshot. The source snapshot can be one of your own snapshots, or a \n" "snapshot owned by another account that has granted you permission via the \n" "[UpdateSnapshot](#updatesnapshot) method.\n* **Importing from a bucket**: You \n" "import a snapshot located in an OUTSCALE Object Storage (OOS) bucket. First, \n" "the owner of the source snapshot must export it to the bucket by using the \n" "[CreateSnapshotExportTask](#createsnapshotexporttask) method. Then, they must \n" "grant you permission to read the snapshot via a pre-signed URL or Access \n" "Control Lists. For more information, see [Managing Access to Your Buckets and \n" "Objects](https://docs.outscale.com/en/userguide/Managing-Access-to-Your-Buckets-\n" "and-Objects.html).\n\n**[NOTE]**\nIn case of excessive use of the snapshot \n" "creation feature on the same volume over a short period of time, 3DS OUTSCALE \n" "reserves the right to temporarily block the feature.\n\nFor more information, \n" "see [About \n" "Snapshots](https://docs.outscale.com/en/userguide/About-Snapshots.html).\n" "\nRequired Argument: \n"
"Usage: oapi-cli CreateSnapshot [OPTIONS]\n" "Creates a snapshot. Snapshots are point-in-time images of a volume that you can \n" "use to back up your data or to create replicas of this volume.\nYou can use \n" "this method in three different ways:\n* **Creating from a volume**: You create \n" "a snapshot from one of your volumes.\n* **Copying a snapshot**: You copy an \n" "existing snapshot. The source snapshot can be one of your own snapshots, or a \n" "snapshot owned by another account that has granted you permission via the \n" "[UpdateSnapshot](#updatesnapshot) method.\n* **Importing from a bucket**: You \n" "import a snapshot located in an OUTSCALE Object Storage (OOS) bucket. First, \n" "the owner of the source snapshot must export it to a bucket by using the \n" "[CreateSnapshotExportTask](#createsnapshotexporttask) method. Then, they must \n" "grant you permission to read the snapshot via a pre-signed URL or Access \n" "Control Lists. For more information, see [Managing Access to Your Buckets and \n" "Objects](https://docs.outscale.com/en/userguide/Managing-Access-to-Your-Buckets-\n" "and-Objects.html).\n\n**[NOTE]**\nIn case of excessive use of the snapshot \n" "creation feature on the same volume over a short period of time, 3DS OUTSCALE \n" "reserves the right to temporarily block the feature.\n\nFor more information, \n" "see [About \n" "Snapshots](https://docs.outscale.com/en/userguide/About-Snapshots.html).\n" "\nRequired Argument: \n"
,
"Usage: oapi-cli CreateServerCertificate --Body=body --PrivateKey=privatekey --Name=name [OPTIONS]\n" "Creates a server certificate and its matching private key.\nThese elements can \n" "be used with other services (for example, to configure SSL termination on load \n" "balancers).\nYou can also specify the chain of intermediate certification \n" "authorities if your certificate is not directly signed by a root one. You can \n" "specify multiple intermediate certification authorities in the \n" "`CertificateChain` parameter. To do so, concatenate all certificates in the \n" "correct order (the first certificate must be the authority of your certificate, \n" "the second must be the authority of the first one, and so on).\nThe private key \n" "must be a RSA key in PKCS1 form. To check this, open the PEM file and ensure \n" "its header reads as follows: BEGIN RSA PRIVATE KEY.\n[IMPORTANT]\nThis private \n" "key must not be protected by a password or a passphrase.\nFor more information, \n" "see [About Server Certificates in \n" "EIM](https://docs.outscale.com/en/userguide/About-Server-Certificates-in-EIM.htm\n" "l).\n" "\nRequired Argument: Body, PrivateKey, Name \n"
,
Expand All @@ -696,7 +696,7 @@ static const char *calls_descriptions[] = {
,
"Usage: oapi-cli CreateNetPeering --AccepterNetId=accepternetid --SourceNetId=sourcenetid [OPTIONS]\n" "Requests a Net peering between a Net you own and a peer Net that belongs to you \n" "or another account.\nThis action creates a Net peering that remains in the \n" "`pending-acceptance` state until it is accepted by the owner of the peer Net. \n" "If the owner of the peer Net does not accept the request within 7 days, the \n" "state of the Net peering becomes `expired`. For more information, see \n" "[AcceptNetPeering](#acceptnetpeering).\n\n**[IMPORTANT]**\n* Peered Nets must \n" "contain at least one virtual machine (VM) each before the creation of the Net \n" "peering.\n* The two Nets must not have overlapping IP ranges. Otherwise, the \n" "Net peering is in the `failed` state.\n* A peering connection between two Nets \n" "works both ways. Therefore, you do not need to create a B-to-A connection if an \n" "A-to-B connection is created and accepted.\n\nFor more information, see [About \n" "Net Peerings](https://docs.outscale.com/en/userguide/About-Net-Peerings.html).\n" "\nRequired Argument: AccepterNetId, SourceNetId \n"
,
"Usage: oapi-cli CreateNetAccessPoint --ServiceName=servicename --NetId=netid [OPTIONS]\n" "Creates a Net access point to access an OUTSCALE service from this Net without \n" "using the Internet and public IPs.\nYou specify the service using its name. For \n" "more information about the available services, see \n" "[ReadNetAccessPointServices](#readnetaccesspointservices).\nTo control the \n" "routing of traffic between the Net and the specified service, you can specify \n" "one or more route tables. Virtual machines placed in Subnets associated with \n" "the specified route table thus use the Net access point to access the service. \n" "When you specify a route table, a route is automatically added to it with the \n" "destination set to the prefix list ID of the service, and the target set to the \n" "ID of the access point.\nFor more information, see [About Net Access \n" "Points](https://docs.outscale.com/en/userguide/About-Net-Access-Points.html).\n" "\nRequired Argument: ServiceName, NetId \n"
"Usage: oapi-cli CreateNetAccessPoint --ServiceName=servicename --NetId=netid [OPTIONS]\n" "Creates a Net access point to access an OUTSCALE service from this Net without \n" "using the Internet and public IPs.\nYou specify the service using its name. For \n" "more information about the available services, see \n" "[ReadNetAccessPointServices](#readnetaccesspointservices). \nTo control the \n" "routing of traffic between the Net and the specified service, you can specify \n" "one or more route tables. Virtual machines placed in Subnets associated with \n" "the specified route table thus use the Net access point to access the service. \n" "When you specify a route table, a route is automatically added to it with the \n" "destination set to the prefix list ID of the service, and the target set to the \n" "ID of the access point.\nWhen a Net access point is created, a public IP is \n" "automatically allocated to your account and used for the Net access point. This \n" "public IP is not connected to the Internet. It is counted in your quota, but it \n" "is not billed. \nFor more information, see [About Net Access \n" "Points](https://docs.outscale.com/en/userguide/About-Net-Access-Points.html).\n" "\nRequired Argument: ServiceName, NetId \n"
,
"Usage: oapi-cli CreateNet --IpRange=iprange [OPTIONS]\n" "Creates a Net with a specified IP range.\nThe IP range (network range) of your \n" "Net must be between a /28 netmask (16 IPs) and a /16 netmask (65536 IPs).\nFor \n" "more information, see [About \n" "Nets](https://docs.outscale.com/en/userguide/About-Nets.html).\n" "\nRequired Argument: IpRange \n"
,
Expand Down Expand Up @@ -888,8 +888,7 @@ static const char *calls_args_descriptions[] = {
"--DryRun: bool\n"
" If true, checks whether you have the required permissions to perform the action.\n"
"--IsSourceDestChecked: bool\n"
" (Net only) If true, the source/destination check is enabled. If false, it is disabled. This \n"
" value must be false for a NAT VM to perform network address translation (NAT) in a Net.\n"
" (Net only) If true, the source/destination check is enabled. If false, it is disabled.\n"
"--KeypairName: string\n"
" The name of a keypair you want to associate with the VM.\nWhen you replace the keypair of a \n"
" VM with another one, the metadata of the VM is modified to reflect the new public key, but \n"
Expand Down Expand Up @@ -1410,7 +1409,7 @@ static const char *calls_args_descriptions[] = {
" --Filters.ClientGatewayIds: array string\n"
" The IDs of the client gateways.\n"
" --Filters.ConnectionTypes: array string\n"
" The types of the VPN connections (only `ipsec.1` is supported).\n"
" The types of the VPN connections (always `ipsec.1`).\n"
" --Filters.RouteDestinationIpRanges: array string\n"
" The destination IP ranges.\n"
" --Filters.States: array string\n"
Expand Down Expand Up @@ -1445,15 +1444,15 @@ static const char *calls_args_descriptions[] = {
"--Filters: ref FiltersVolume\n"
" One or more filters.\n"
" --Filters.CreationDates: array string\n"
" The dates and times of creation of the volumes, in ISO 8601 date-time \n"
" format (for example, `2020-06-30T00:00:00.000Z`).\n"
" The dates and times at which the volumes were created, in ISO 8601 \n"
" date-time format (for example, `2020-06-30T00:00:00.000Z`).\n"
" --Filters.LinkVolumeDeleteOnVmDeletion: bool\n"
" Whether the volumes are deleted or not when terminating the VMs.\n"
" --Filters.LinkVolumeDeviceNames: array string\n"
" The VM device names.\n"
" --Filters.LinkVolumeLinkDates: array string\n"
" The dates and times of creation of the volumes, in ISO 8601 date-time \n"
" format (for example, `2020-06-30T00:00:00.000Z`).\n"
" The dates and times at which the volumes were attached, in ISO 8601 \n"
" date-time format (for example, `2020-06-30T00:00:00.000Z`).\n"
" --Filters.LinkVolumeLinkStates: array string\n"
" The attachment states of the volumes (`attaching` \\| `detaching` \\| \n"
" `attached` \\| `detached`).\n"
Expand Down Expand Up @@ -1714,7 +1713,7 @@ static const char *calls_args_descriptions[] = {
"--DryRun: bool\n"
" If true, checks whether you have the required permissions to perform the action.\n"
"--Filters: ref FiltersVmTemplate\n"
" null\n"
" One or more filters.\n"
" --Filters.CpuCores: array integer\n"
" The number of vCores.\n"
" --Filters.CpuGenerations: array string\n"
Expand Down Expand Up @@ -1774,7 +1773,7 @@ static const char *calls_args_descriptions[] = {
"--Filters: ref FiltersVirtualGateway\n"
" One or more filters.\n"
" --Filters.ConnectionTypes: array string\n"
" The types of the virtual gateways (only `ipsec.1` is supported).\n"
" The types of the virtual gateways (always `ipsec.1`).\n"
" --Filters.LinkNetIds: array string\n"
" The IDs of the Nets the virtual gateways are attached to.\n"
" --Filters.LinkStates: array string\n"
Expand Down Expand Up @@ -2736,8 +2735,8 @@ static const char *calls_args_descriptions[] = {
" --Filters.ClientGatewayIds: array string\n"
" The IDs of the client gateways.\n"
" --Filters.ConnectionTypes: array string\n"
" The types of communication tunnels used by the client gateways (only \n"
" `ipsec.1` is supported).\n"
" The types of communication tunnels used by the client gateways (always \n"
" `ipsec.1`).\n"
" --Filters.PublicIps: array string\n"
" The public IPv4 addresses of the client gateways.\n"
" --Filters.States: array string\n"
Expand Down Expand Up @@ -2905,7 +2904,8 @@ static const char *calls_args_descriptions[] = {
"--PolicyDocument: string\n"
" The policy document, corresponding to a JSON string that contains the policy. For more \n"
" information, see [EIM Reference \n"
" Information](https://docs.outscale.com/en/userguide/EIM-Reference-Information.html).\n"
" Information](https://docs.outscale.com/en/userguide/EIM-Reference-Information.html) and \n"
" [EIM Policy Generator](https://docs.outscale.com/en/userguide/EIM-Policy-Generator.html).\n"
"--PolicyName: string\n"
" The name of the policy.\n"
"--UserGroupName: string\n"
Expand Down Expand Up @@ -3353,7 +3353,7 @@ static const char *calls_args_descriptions[] = {
"--ClientGatewayId: string\n"
" The ID of the client gateway.\n"
"--ConnectionType: string\n"
" The type of VPN connection (only `ipsec.1` is supported).\n"
" The type of VPN connection (always `ipsec.1`).\n"
"--DryRun: bool\n"
" If true, checks whether you have the required permissions to perform the action.\n"
"--StaticRoutesOnly: bool\n"
Expand Down Expand Up @@ -3575,7 +3575,7 @@ static const char *calls_args_descriptions[] = {
" The ID of the VM template used to launch VMs in the VM group.\n"
,
"--ConnectionType: string\n"
" The type of VPN connection supported by the virtual gateway (only `ipsec.1` is supported).\n"
" The type of VPN connection supported by the virtual gateway (always `ipsec.1`).\n"
"--DryRun: bool\n"
" If true, checks whether you have the required permissions to perform the action.\n"
,
Expand Down Expand Up @@ -3796,7 +3796,8 @@ static const char *calls_args_descriptions[] = {
"--Document: string\n"
" The policy document, corresponding to a JSON string that contains the policy. For more \n"
" information, see [EIM Reference \n"
" Information](https://docs.outscale.com/en/userguide/EIM-Reference-Information.html).\n"
" Information](https://docs.outscale.com/en/userguide/EIM-Reference-Information.html) and \n"
" [EIM Policy Generator](https://docs.outscale.com/en/userguide/EIM-Policy-Generator.html).\n"
"--PolicyOrn: string\n"
" The OUTSCALE Resource Name (ORN) of the policy. For more information, see [Resource \n"
" Identifiers](https://docs.outscale.com/en/userguide/Resource-Identifiers.html).\n"
Expand All @@ -3809,7 +3810,8 @@ static const char *calls_args_descriptions[] = {
"--Document: string\n"
" The policy document, corresponding to a JSON string that contains the policy. For more \n"
" information, see [EIM Reference \n"
" Information](https://docs.outscale.com/en/userguide/EIM-Reference-Information.html).\n"
" Information](https://docs.outscale.com/en/userguide/EIM-Reference-Information.html) and \n"
" [EIM Policy Generator](https://docs.outscale.com/en/userguide/EIM-Policy-Generator.html).\n"
"--DryRun: bool\n"
" If true, checks whether you have the required permissions to perform the action.\n"
"--Path: string\n"
Expand Down Expand Up @@ -3895,7 +3897,7 @@ static const char *calls_args_descriptions[] = {
"--LoadBalancerName: string\n"
" The name of the load balancer for which you want to create a policy.\n"
"--PolicyName: string\n"
" The name of the policy. This name must be unique and consist of alphanumeric characters and \n"
" The unique name of the policy, with a maximum length of 32 alphanumeric characters and \n"
" dashes (-).\n"
"--PolicyType: string\n"
" The type of stickiness policy you want to create: `app` or `load_balancer`.\n"
Expand Down Expand Up @@ -3946,8 +3948,8 @@ static const char *calls_args_descriptions[] = {
" (ORNs)](https://docs.outscale.com/en/userguide/Resource-Identifiers.html#_\n"
" outscale_resource_names_orns).\n"
"--LoadBalancerName: string\n"
" The unique name of the load balancer (32 alphanumeric or hyphen characters maximum, but \n"
" cannot start or end with a hyphen).\n"
" The unique name of the load balancer, with a maximum length of 32 alphanumeric characters \n"
" and dashes (-). This name must not start or end with a dash.\n"
"--LoadBalancerType: string\n"
" The type of load balancer: `internet-facing` or `internal`. Use this parameter only for \n"
" load balancers in a Net.\n"
Expand Down Expand Up @@ -4187,8 +4189,8 @@ static const char *calls_args_descriptions[] = {
" and `4294967295`. If you do not have an ASN, you can choose one between 64512 and 65534, or \n"
" between 4200000000 and 4294967294.\n"
"--ConnectionType: string\n"
" The communication protocol used to establish tunnel with your client gateway (only \n"
" `ipsec.1` is supported).\n"
" The communication protocol used to establish tunnel with your client gateway (always \n"
" `ipsec.1`).\n"
"--DryRun: bool\n"
" If true, checks whether you have the required permissions to perform the action.\n"
"--PublicIp: string\n"
Expand Down
Loading

0 comments on commit 53e47ac

Please sign in to comment.